Home /  API Reference / 

Functions

Download OpenAPI

ReadFunction

GET/functions/{functionName}
Retrieve an existing function.
Parameters
Requiredpath
Pattern: ^([a-zA-Z0-9-_]+)$

Example

GET
https://functions.cloud.us.stedi.com/2021-11-16/functions/E

UpdateFunction

PUT/functions/{functionName}
Update an existing function.
Parameters
Requiredpath
Pattern: ^([a-zA-Z0-9-_]+)$
Optionalheader

[EXPERIMENTAL FEATURE] The operation preference for asynchronous responses based on RFC 7240: https://datatracker.ietf.org/doc/html/rfc7240

Possible values

respond-async

Request body

application/json

Optionalstring
How long the log events will be retained.

Possible values

one_day three_days five_days one_week two_weeks one_month two_months three_months four_months five_months ...

Optionalobject
A reference to a Bucket object containing a function package.
PackageReference object.

Optionalstring
Optionalbyte
The function code that has been packaged. Write-only. Limited to 3.25MB.
Optionalnumber
The amount of time (in seconds) that the runtime allows a function to run before stopping it. The default is 3 seconds. The value can range between 1 and 900.
Optionalpassword
EnvironmentVariables object.

Example

PUT
https://functions.cloud.us.stedi.com/2021-11-16/functions/pv

DeleteFunction

DELETE/functions/{functionName}
Delete an existing function.
Parameters
Requiredpath
Pattern: ^([a-zA-Z0-9-_]+)$
Optionalheader

[EXPERIMENTAL FEATURE] The operation preference for asynchronous responses based on RFC 7240: https://datatracker.ietf.org/doc/html/rfc7240

Possible values

respond-async

Example

DELETE
https://functions.cloud.us.stedi.com/2021-11-16/functions/y-m

InvokeFunction

POST/functions/{functionName}/invocations
Invoke function.
Parameters
Requiredpath
Pattern: ^([a-zA-Z0-9-_]+)$
Optionalheader
Optionalheader

Specify 'Event' for asynchronous invocation. The default invocation type is 'RequestResponse' (or synchronous) Asynchronous invocations can have a request body payload up to 256KB.

Possible values

RequestResponse Event

Request body

application/octet-stream

The input data that you want to provide during execution.

Requiredstring

body
Requiredapplication/octet-stream

Binary representation of the file

Example

POST
https://functions.cloud.us.stedi.com/2021-11-16/functions/2nKbyw/invocations

CreateFunctionAccessRequest

POST/request-access
Request Access to functions.
Request body

application/json

Requiredstring

Example

POST
https://functions.cloud.us.stedi.com/2021-11-16/request-access

ListFunctions

GET/functions
Retrieve a list containing every function.
Parameters
Optionalquery
The maximum number of elements to return in a page
Optionalquery
The token used for pagination

Example

GET
https://functions.cloud.us.stedi.com/2021-11-16/functions?pageSize=1&pageToken=...

CreateFunction

POST/functions
Create a new function.
Parameters
Optionalheader

[EXPERIMENTAL FEATURE] The operation preference for asynchronous responses based on RFC 7240: https://datatracker.ietf.org/doc/html/rfc7240

Possible values

respond-async

Request body

application/json

Optionalstring
How long the log events will be retained.

Possible values

one_day three_days five_days one_week two_weeks one_month two_months three_months four_months five_months ...

Optionalobject
A reference to a Bucket object containing a function package.
PackageReference object.

Optionalstring
Optionalbyte
The function code that has been packaged. Write-only. Limited to 3.25MB.
Requiredstring
Optionalpassword
EnvironmentVariables object.

Optionalnumber
The amount of time (in seconds) that the runtime allows a function to run before stopping it. The default is 3 seconds. The value can range between 1 and 900.

Example

POST
https://functions.cloud.us.stedi.com/2021-11-16/functions