Functions

SERVER

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 functions

Get a list of all the project's functions. You can use the query params to filter your results.

Request
- 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: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId
- search string
  
  Search term to filter your list results. Max length: 256 chars.
Response
- 200 application/json
  
  Functions List

Endpoint

GET /functions

GraphQL

query {
    functionsList {
        total
        functions {
            _id
            _createdAt
            _updatedAt
            execute
            name
            enabled
            live
            logging
            runtime
            deployment
            vars {
                _id
                _createdAt
                _updatedAt
                key
                value
                resourceType
                resourceId
            }
            events
            schedule
            timeout
            entrypoint
            commands
            version
            installationId
            providerRepositoryId
            providerBranch
            providerRootDirectory
            providerSilentMode
        }
    }
}

Create function

Create a new function. You can pass a list of permissions to allow different project users or team with access to execute the function using the client API.

Request
- functionId string
  required
  
  Function ID. Choose a custom ID or generate a random ID with ID.unique(). Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
- name string
  required
  
  Function name. Max length: 128 chars.
- runtime string
  required
  
  Execution runtime.
- execute array
  
  An array of role strings with execution permissions. By default no user is granted with any execute permissions. learn more about roles. Maximum of 100 roles are allowed, each 64 characters long.
- events array
  
  Events list. Maximum of 100 events are allowed.
- schedule string
  
  Schedule CRON syntax.
- timeout integer
  
  Function maximum execution time in seconds.
- enabled boolean
  
  Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
- logging boolean
  
  Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.
- entrypoint string
  
  Entrypoint File. This path is relative to the "providerRootDirectory".
- commands string
  
  Build Commands.
- installationId string
  
  Appwrite Installation ID for VCS (Version Control System) deployment.
- providerRepositoryId string
  
  Repository ID of the repo linked to the function.
- providerBranch string
  
  Production branch for the repo linked to the function.
- providerSilentMode boolean
  
  Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
- providerRootDirectory string
  
  Path to function code in the linked repo.
- templateRepository string
  
  Repository name of the template.
- templateOwner string
  
  The name of the owner of the template.
- templateRootDirectory string
  
  Path to function code in the template repo.
- templateBranch string
  
  Production branch for the repo linked to the function template.
Response
- 201 application/json
  
  Function

Endpoint

POST /functions

GraphQL

mutation {
    functionsCreate(
        functionId: "[FUNCTION_ID]",
        name: "[NAME]",
        runtime: "node-18.0"
    ) {
        _id
        _createdAt
        _updatedAt
        execute
        name
        enabled
        live
        logging
        runtime
        deployment
        vars {
            _id
            _createdAt
            _updatedAt
            key
            value
            resourceType
            resourceId
        }
        events
        schedule
        timeout
        entrypoint
        commands
        version
        installationId
        providerRepositoryId
        providerBranch
        providerRootDirectory
        providerSilentMode
    }
}

List runtimes

Get a list of all runtimes that are currently active on your instance.

Response
- 200 application/json
  
  Runtimes List

Endpoint

GET /functions/runtimes

GraphQL

query {
    functionsListRuntimes {
        total
        runtimes {
            _id
            name
            version
            base
            image
            logo
            supports
        }
    }
}

Get function

Get a function by its unique ID.

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

Endpoint

GET /functions/{functionId}

GraphQL

query {
    functionsGet(
        functionId: "[FUNCTION_ID]"
    ) {
        _id
        _createdAt
        _updatedAt
        execute
        name
        enabled
        live
        logging
        runtime
        deployment
        vars {
            _id
            _createdAt
            _updatedAt
            key
            value
            resourceType
            resourceId
        }
        events
        schedule
        timeout
        entrypoint
        commands
        version
        installationId
        providerRepositoryId
        providerBranch
        providerRootDirectory
        providerSilentMode
    }
}

Update function

Update function by its unique ID.

Request
- functionId string
  required
  
  Function ID.
- name string
  required
  
  Function name. Max length: 128 chars.
- runtime string
  
  Execution runtime.
- execute array
  
  An array of role strings with execution permissions. By default no user is granted with any execute permissions. learn more about roles. Maximum of 100 roles are allowed, each 64 characters long.
- events array
  
  Events list. Maximum of 100 events are allowed.
- schedule string
  
  Schedule CRON syntax.
- timeout integer
  
  Maximum execution time in seconds.
- enabled boolean
  
  Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
- logging boolean
  
  Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.
- entrypoint string
  
  Entrypoint File. This path is relative to the "providerRootDirectory".
- commands string
  
  Build Commands.
- installationId string
  
  Appwrite Installation ID for VCS (Version Controle System) deployment.
- providerRepositoryId string
  
  Repository ID of the repo linked to the function
- providerBranch string
  
  Production branch for the repo linked to the function
- providerSilentMode boolean
  
  Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
- providerRootDirectory string
  
  Path to function code in the linked repo.
Response
- 200 application/json
  
  Function

Endpoint

PUT /functions/{functionId}

GraphQL

mutation {
    functionsUpdate(
        functionId: "[FUNCTION_ID]",
        name: "[NAME]"
    ) {
        _id
        _createdAt
        _updatedAt
        execute
        name
        enabled
        live
        logging
        runtime
        deployment
        vars {
            _id
            _createdAt
            _updatedAt
            key
            value
            resourceType
            resourceId
        }
        events
        schedule
        timeout
        entrypoint
        commands
        version
        installationId
        providerRepositoryId
        providerBranch
        providerRootDirectory
        providerSilentMode
    }
}

Delete function

Delete a function by its unique ID.

Request
- functionId string
  required
  
  Function ID.
Response
- 204 application/json

Endpoint

DELETE /functions/{functionId}

GraphQL

mutation {
    functionsDelete(
        functionId: "[FUNCTION_ID]"
    ) {
        status
    }
}

List deployments

Get a list of all the project's code deployments. 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: size, buildId, activate, entrypoint, commands
- search string
  
  Search term to filter your list results. Max length: 256 chars.
Response
- 200 application/json
  
  Deployments List

Endpoint

GET /functions/{functionId}/deployments

GraphQL

query {
    functionsListDeployments(
        functionId: "[FUNCTION_ID]"
    ) {
        total
        deployments {
            _id
            _createdAt
            _updatedAt
            type
            resourceId
            resourceType
            entrypoint
            size
            buildId
            activate
            status
            buildLogs
            buildTime
            providerRepositoryName
            providerRepositoryOwner
            providerRepositoryUrl
            providerBranch
            providerCommitHash
            providerCommitAuthorUrl
            providerCommitAuthor
            providerCommitMessage
            providerCommitUrl
            providerBranchUrl
        }
    }
}

Create deployment

Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.

This endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the Appwrite Cloud Functions tutorial.

Use the "command" param to set the entrypoint used to execute your code.

Request
- functionId string
  required
  
  Function ID.
- code string
  required
  
  Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.
- activate boolean
  required
  
  Automatically activate the deployment when it is finished building.
- entrypoint string
  
  Entrypoint File.
- commands string
  
  Build Commands.
Response
- 202 application/json
  
  Deployment

Endpoint

POST /functions/{functionId}/deployments

GraphQL

POST /v1/functions/{functionId}/deployments HTTP/1.1
Host: HOSTNAME
Content-Type: multipart/form-data; boundary="cec8e8123c05ba25"
X-Appwrite-Response-Format: 1.4.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
Content-Length: *Length of your entity body in bytes*

--cec8e8123c05ba25
Content-Disposition: form-data; name="operations"

{ "query": "mutation { functionsCreateDeployment(functionId: $functionId, code: $code, activate: $activate) { id }" }, "variables": { "functionId": "[FUNCTION_ID]", "code": null, "activate": false } }

--cec8e8123c05ba25
Content-Disposition: form-data; name="map"

{ "0": ["variables.code"],  }

--cec8e8123c05ba25
Content-Disposition: form-data; name="0"; filename="code.ext"

File contents

--cec8e8123c05ba25--

Get deployment

Get a code deployment by its unique ID.

Request
- functionId string
  required
  
  Function ID.
- deploymentId string
  required
  
  Deployment ID.
Response
- 200 application/json
  
  Deployment

Endpoint

GET /functions/{functionId}/deployments/{deploymentId}

GraphQL

query {
    functionsGetDeployment(
        functionId: "[FUNCTION_ID]",
        deploymentId: "[DEPLOYMENT_ID]"
    ) {
        _id
        _createdAt
        _updatedAt
        type
        resourceId
        resourceType
        entrypoint
        size
        buildId
        activate
        status
        buildLogs
        buildTime
        providerRepositoryName
        providerRepositoryOwner
        providerRepositoryUrl
        providerBranch
        providerCommitHash
        providerCommitAuthorUrl
        providerCommitAuthor
        providerCommitMessage
        providerCommitUrl
        providerBranchUrl
    }
}

Update function deployment

Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.

Request
- functionId string
  required
  
  Function ID.
- deploymentId string
  required
  
  Deployment ID.
Response
- 200 application/json
  
  Function

Endpoint

PATCH /functions/{functionId}/deployments/{deploymentId}

GraphQL

mutation {
    functionsUpdateDeployment(
        functionId: "[FUNCTION_ID]",
        deploymentId: "[DEPLOYMENT_ID]"
    ) {
        _id
        _createdAt
        _updatedAt
        execute
        name
        enabled
        live
        logging
        runtime
        deployment
        vars {
            _id
            _createdAt
            _updatedAt
            key
            value
            resourceType
            resourceId
        }
        events
        schedule
        timeout
        entrypoint
        commands
        version
        installationId
        providerRepositoryId
        providerBranch
        providerRootDirectory
        providerSilentMode
    }
}

Delete deployment

Delete a code deployment by its unique ID.

Request
- functionId string
  required
  
  Function ID.
- deploymentId string
  required
  
  Deployment ID.
Response
- 204 application/json

Endpoint

DELETE /functions/{functionId}/deployments/{deploymentId}

GraphQL

mutation {
    functionsDeleteDeployment(
        functionId: "[FUNCTION_ID]",
        deploymentId: "[DEPLOYMENT_ID]"
    ) {
        status
    }
}

Create build

Create a new build for an Appwrite Function deployment. This endpoint can be used to retry a failed build.

Request
- functionId string
  required
  
  Function ID.
- deploymentId string
  required
  
  Deployment ID.
- buildId string
  required
  
  Build unique ID.
Response
- 204 application/json

Endpoint

POST /functions/{functionId}/deployments/{deploymentId}/builds/{buildId}

GraphQL

mutation {
    functionsCreateBuild(
        functionId: "[FUNCTION_ID]",
        deploymentId: "[DEPLOYMENT_ID]",
        buildId: "[BUILD_ID]"
    ) {
        status
    }
}

Download Deployment

Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.

Request
- functionId string
  required
  
  Function ID.
- deploymentId string
  required
  
  Deployment ID.
Response
- 200 application/json

Endpoint

GET /functions/{functionId}/deployments/{deploymentId}/download

GraphQL

query {
    functionsDownloadDeployment(
        functionId: "[FUNCTION_ID]",
        deploymentId: "[DEPLOYMENT_ID]"
    ) {
        status
    }
}

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
    }
}

List variables

Get a list of all variables of a specific function.

Request
- functionId string
  required
  
  Function unique ID.
Response
- 200 application/json
  
  Variables List

Endpoint

GET /functions/{functionId}/variables

GraphQL

query {
    functionsListVariables(
        functionId: "[FUNCTION_ID]"
    ) {
        total
        variables {
            _id
            _createdAt
            _updatedAt
            key
            value
            resourceType
            resourceId
        }
    }
}

Create variable

Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.

Request
- functionId string
  required
  
  Function unique ID.
- key string
  required
  
  Variable key. Max length: 255 chars.
- value string
  required
  
  Variable value. Max length: 8192 chars.
Response
- 201 application/json
  
  Variable

Endpoint

POST /functions/{functionId}/variables

GraphQL

mutation {
    functionsCreateVariable(
        functionId: "[FUNCTION_ID]",
        key: "[KEY]",
        value: "[VALUE]"
    ) {
        _id
        _createdAt
        _updatedAt
        key
        value
        resourceType
        resourceId
    }
}

Get variable

Get a variable by its unique ID.

Request
- functionId string
  required
  
  Function unique ID.
- variableId string
  required
  
  Variable unique ID.
Response
- 200 application/json
  
  Variable

Endpoint

GET /functions/{functionId}/variables/{variableId}

GraphQL

query {
    functionsGetVariable(
        functionId: "[FUNCTION_ID]",
        variableId: "[VARIABLE_ID]"
    ) {
        _id
        _createdAt
        _updatedAt
        key
        value
        resourceType
        resourceId
    }
}

Update variable

Update variable by its unique ID.

Request
- functionId string
  required
  
  Function unique ID.
- variableId string
  required
  
  Variable unique ID.
- key string
  required
  
  Variable key. Max length: 255 chars.
- value string
  
  Variable value. Max length: 8192 chars.
Response
- 200 application/json
  
  Variable

Endpoint

PUT /functions/{functionId}/variables/{variableId}

GraphQL

mutation {
    functionsUpdateVariable(
        functionId: "[FUNCTION_ID]",
        variableId: "[VARIABLE_ID]",
        key: "[KEY]"
    ) {
        _id
        _createdAt
        _updatedAt
        key
        value
        resourceType
        resourceId
    }
}

Delete variable

Delete a variable by its unique ID.

Request
- functionId string
  required
  
  Function unique ID.
- variableId string
  required
  
  Variable unique ID.
Response
- 204 application/json

Endpoint

DELETE /functions/{functionId}/variables/{variableId}

GraphQL

mutation {
    functionsDeleteVariable(
        functionId: "[FUNCTION_ID]",
        variableId: "[VARIABLE_ID]"
    ) {
        status
    }
}

Recommended