Create Execution

POST

/functions/{functionId}/executions

functions

Trigger a function execution. The returned object will return you the current execution status. You can ping the Get Execution endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://appwrite.io/v1/functions//executions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": "string"
}'

Response Example

{
    "$id": "string",
    "dateCreated": 0,
    "exitCode": 0,
    "functionId": "string",
    "status": "string",
    "stderr": "string",
    "stdout": "string",
    "time": 0,
    "trigger": "string"
}

Request

Path Params

functionId

string

required

Function unique ID.

Body Params application/json

data

string

optional

String of custom data to send to function.

Examples

Responses

🟢201Execution

application/json

Body

Execution

$id

string

required

Execution ID.

dateCreated

integer <int32>

required

The execution creation date in Unix timestamp.

exitCode

integer <int32>

required

The script exit code.

functionId

string

required

Function ID.

status

string

required

The status of the function execution. Possible values can be: waiting, processing, completed, or failed.

stderr

string

required

The script stderr output string. Logs the last 4,000 characters of the execution stderr output

stdout

string

required

The script stdout output string. Logs the last 4,000 characters of the execution stdout output.

time

number <float>

required

The script execution time in seconds.

trigger

string

required

The trigger that caused the function to execute. Possible values can be: http, schedule, or event.

Modified at 2023-08-16 07:28:13

List Executions

Get Execution