Go to Console
Star on GitHub 45.1K Get started

Functions

SERVER

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
Endpoint
GET /functions
REST
GET /v1/functions HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

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
Endpoint
POST /functions
REST
POST /v1/functions HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

{
  "functionId": "<FUNCTION_ID>",
  "name": "<NAME>",
  "runtime": "node-14.5",
  "execute": ["any"],
  "events": [],
  "schedule": ,
  "timeout": 1,
  "enabled": false,
  "logging": false,
  "entrypoint": "<ENTRYPOINT>",
  "commands": "<COMMANDS>",
  "installationId": "<INSTALLATION_ID>",
  "providerRepositoryId": "<PROVIDER_REPOSITORY_ID>",
  "providerBranch": "<PROVIDER_BRANCH>",
  "providerSilentMode": false,
  "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>",
  "templateRepository": "<TEMPLATE_REPOSITORY>",
  "templateOwner": "<TEMPLATE_OWNER>",
  "templateRootDirectory": "<TEMPLATE_ROOT_DIRECTORY>",
  "templateBranch": "<TEMPLATE_BRANCH>"
}

List runtimes

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

Endpoint
GET /functions/runtimes
REST
GET /v1/functions/runtimes HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

Get function

Get a function by its unique ID.

  • Request
    • functionId string
      required

      Function ID.

  • Response
Endpoint
GET /functions/{functionId}
REST
GET /v1/functions/{functionId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

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
Endpoint
PUT /functions/{functionId}
REST
PUT /v1/functions/{functionId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

{
  "name": "<NAME>",
  "runtime": "node-14.5",
  "execute": ["any"],
  "events": [],
  "schedule": ,
  "timeout": 1,
  "enabled": false,
  "logging": false,
  "entrypoint": "<ENTRYPOINT>",
  "commands": "<COMMANDS>",
  "installationId": "<INSTALLATION_ID>",
  "providerRepositoryId": "<PROVIDER_REPOSITORY_ID>",
  "providerBranch": "<PROVIDER_BRANCH>",
  "providerSilentMode": false,
  "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>"
}

Delete function

Delete a function by its unique ID.

  • Request
    • functionId string
      required

      Function ID.

  • Response
    • 204 application/json
Endpoint
DELETE /functions/{functionId}
REST
DELETE /v1/functions/{functionId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

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
Endpoint
GET /functions/{functionId}/deployments
REST
GET /v1/functions/{functionId}/deployments HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

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
Endpoint
POST /functions/{functionId}/deployments
REST
POST /v1/functions/{functionId}/deployments HTTP/1.1
Host: cloud.appwrite.io
Content-Type: multipart/form-data; boundary="cec8e8123c05ba25"
X-Appwrite-Response-Format: 1.5.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="entrypoint"

"<ENTRYPOINT>"

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

"<COMMANDS>"

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

cf 94 84 24 8d c4 91 10 0f dc 54 26 6c 8e 4b bc 
e8 ee 55 94 29 e7 94 89 19 26 28 01 26 29 3f 16...

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

false

--cec8e8123c05ba25--

Get deployment

Get a code deployment by its unique ID.

  • Request
    • functionId string
      required

      Function ID.

    • deploymentId string
      required

      Deployment ID.

  • Response
Endpoint
GET /functions/{functionId}/deployments/{deploymentId}
REST
GET /v1/functions/{functionId}/deployments/{deploymentId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

Update 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
Endpoint
PATCH /functions/{functionId}/deployments/{deploymentId}
REST
PATCH /v1/functions/{functionId}/deployments/{deploymentId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

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}
REST
DELETE /v1/functions/{functionId}/deployments/{deploymentId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

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}
REST
POST /v1/functions/{functionId}/deployments/{deploymentId}/builds/{buildId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

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
REST
GET /v1/functions/{functionId}/deployments/{deploymentId}/download HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

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
Endpoint
GET /functions/{functionId}/executions
REST
GET /v1/functions/{functionId}/executions HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Session: 
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...

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
Endpoint
POST /functions/{functionId}/executions
REST
POST /v1/functions/{functionId}/executions HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Session: 
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...

{
  "body": "<BODY>",
  "async": false,
  "path": "<PATH>",
  "method": "GET",
  "headers": {}
}

Get execution

Get a function execution log by its unique ID.

  • Request
    • functionId string
      required

      Function ID.

    • executionId string
      required

      Execution ID.

  • Response
Endpoint
GET /functions/{functionId}/executions/{executionId}
REST
GET /v1/functions/{functionId}/executions/{executionId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Session: 
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...

List variables

Get a list of all variables of a specific function.

  • Request
    • functionId string
      required

      Function unique ID.

  • Response
Endpoint
GET /functions/{functionId}/variables
REST
GET /v1/functions/{functionId}/variables HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

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
Endpoint
POST /functions/{functionId}/variables
REST
POST /v1/functions/{functionId}/variables HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

{
  "key": "<KEY>",
  "value": "<VALUE>"
}

Get variable

Get a variable by its unique ID.

  • Request
    • functionId string
      required

      Function unique ID.

    • variableId string
      required

      Variable unique ID.

  • Response
Endpoint
GET /functions/{functionId}/variables/{variableId}
REST
GET /v1/functions/{functionId}/variables/{variableId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

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
Endpoint
PUT /functions/{functionId}/variables/{variableId}
REST
PUT /v1/functions/{functionId}/variables/{variableId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2

{
  "key": "<KEY>",
  "value": "<VALUE>"
}

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}
REST
DELETE /v1/functions/{functionId}/variables/{variableId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.5.0
X-Appwrite-Project: 5df5acd0d48c2
X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
Copyright © 2024 Appwrite