API Reference

Update a Zambda Function

patch
https://zambda-api.zapehr.com/v1/zambda/

Update the Zambda Function with the provided ID or name. Zambdas are functions that can be used to execute your code. They can be used to process data received from Oystehr's APIs or to perform operations on third-party services.

Access Policy Action: Zambda:UpdateFunction
Access Policy Resource: Zambda:Function

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID or name of the Zambda Function to update.

Body Params
string

A name for the Zambda Function. May contain letters, numbers, dashes, and underscores. Must be unique within the project.

string
enum

The trigger method for the Zambda Function determines how the Function is invoked. Learn more about the different types here, https://docs.oystehr.com/oystehr/services/zambda/#types-of-zambdas.

Allowed:
schedule
object

Required when triggerMethod is 'cron', the schedule object defines when the Zambda Function is invoked.

string
enum

The runtime to use for the Zambda Function.

integer
128 to 10240
Defaults to 1024

The amount of memory in MB to allocate to the Zambda Function. If not specified, a system default (1024MB) will be used. Min: 128MB, Max: 10240MB.

integer
1 to 900
Defaults to 27

The timeout for the Zambda Function in seconds. If not specified, a system default (27 seconds) will be used. Min: 1s, Max: 900s (15 minutes). Note: For 'http_auth' and 'http_open' trigger methods, the timeout cannot exceed 27 seconds due to API Gateway limitations.

string

The ID of the IAM role that the Zambda Function will assume when it is invoked.

Responses

404

Zambda Function not found

Updated 3 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago