Docs
Skip to content
post

Create execution

Endpoint

posthttps://<REGION>.cloud.appwrite.io/v1/functions/{functionId}/executions

Description

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.

Required scopes

executions.writeexecution.write

Authentication

Initialize the Appwrite client with setProject() and ensure the user is signed in. The SDK sends the session header automatically after login.

Path

string
Required

Function ID.

Body

string

HTTP body of execution. Default value is empty string.

boolean

Execute code in the background. Default value is false.

string

HTTP path of execution. Path can include query params. Default value is /

enum

HTTP method of execution. Default value is POST.

object

HTTP headers of execution. Defaults to empty.

string

Scheduled execution time in ISO 8601 format. DateTime value must be in future with precision in minutes.

Status
Content type
201
application/json

Execution

Name
Type
Description
string

Execution ID.

string

Execution creation date in ISO 8601 format.

string

Execution update date in ISO 8601 format.

arrayof string

Execution roles.

string

Function ID.

string

Function's deployment ID used to create the execution.

http | schedule | event

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

waiting | processing | completed | failed | scheduled

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

string

HTTP request method type.

string

HTTP request path and query.

arrayof Headers

HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.

Object type

integer

HTTP response status code.

string

HTTP response body. This will return empty unless execution is created as synchronous.

arrayof Headers

HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.

Object type

string

Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.

string

Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.

number

Resource(function/site) execution duration in seconds.

string

The scheduled time for execution. If left empty, execution will be queued immediately.

JavaScript
import { Client, Functions, ExecutionMethod } from "appwrite";


const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID


const functions = new Functions(client);


const result = await functions.createExecution({
    functionId: '<FUNCTION_ID>',
    body: '<BODY>', // optional
    async: false, // optional
    xpath: '<PATH>', // optional
    method: ExecutionMethod.GET, // optional
    headers: {}, // optional
    scheduledAt: '<SCHEDULED_AT>' // optional
});


console.log(result);