Functions

CLIENT

Platform

Version

The Functions service allows you to create custom behaviour that can be triggered by any supported Appwrite system events or by a predefined schedule.

Appwrite Cloud Functions lets you automatically run backend code in response to events triggered by Appwrite or by setting it to be executed in a predefined schedule. Your code is stored in a secure way on your Appwrite instance and is executed in an isolated environment.

You can learn more by following our Cloud Functions tutorial.

Base URL

https://cloud.appwrite.io/v1

List executions

Get a list of all the current user function execution logs. You can use the query params to filter your results.

Request
- functionId string
  required
  
  Function ID.
- queries array
  
  Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration
- search string
  
  Search term to filter your list results. Max length: 256 chars.
Response
- 200 application/json
  
  Executions List

Endpoint

GET /functions/{functionId}/executions

GraphQL

query {
    functionsListExecutions(
        functionId: "[FUNCTION_ID]"
    ) {
        total
        executions {
            _id
            _createdAt
            _updatedAt
            _permissions
            functionId
            trigger
            status
            requestMethod
            requestPath
            requestHeaders {
                name
                value
            }
            responseStatusCode
            responseBody
            responseHeaders {
                name
                value
            }
            logs
            errors
            duration
        }
    }
}

Create execution

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
- functionId string
  required
  
  Function ID.
- body string
  
  HTTP body of execution. Default value is empty string.
- async boolean
  
  Execute code in the background. Default value is false.
- path string
  
  HTTP path of execution. Path can include query params. Default value is /
- method string
  
  HTTP method of execution. Default value is GET.
- headers object
  
  HTTP headers of execution. Defaults to empty.
Response
- 201 application/json
  
  Execution

Endpoint

POST /functions/{functionId}/executions

GraphQL

mutation {
    functionsCreateExecution(
        functionId: "[FUNCTION_ID]"
    ) {
        _id
        _createdAt
        _updatedAt
        _permissions
        functionId
        trigger
        status
        requestMethod
        requestPath
        requestHeaders {
            name
            value
        }
        responseStatusCode
        responseBody
        responseHeaders {
            name
            value
        }
        logs
        errors
        duration
    }
}

Get execution

Get a function execution log by its unique ID.

Request
- functionId string
  required
  
  Function ID.
- executionId string
  required
  
  Execution ID.
Response
- 200 application/json
  
  Execution

Endpoint

GET /functions/{functionId}/executions/{executionId}

GraphQL

query {
    functionsGetExecution(
        functionId: "[FUNCTION_ID]",
        executionId: "[EXECUTION_ID]"
    ) {
        _id
        _createdAt
        _updatedAt
        _permissions
        functionId
        trigger
        status
        requestMethod
        requestPath
        requestHeaders {
            name
            value
        }
        responseStatusCode
        responseBody
        responseHeaders {
            name
            value
        }
        logs
        errors
        duration
    }
}

Recommended