Own Appwrite? Customize your docs with AI search, analytics, and more.

POST

Create Function

https://appwrite.io/v1/functions

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.

Access Token Required: API Key

Body Params

namestringrequired

Function name. Max length: 128 chars.

varsobject

Key-value JSON object.

eventsarray

Events list.

executearrayrequired

An array of strings with execution permissions. By default no user is granted with any execute permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.

runtimestringrequired

Execution runtime.

timeoutinteger

Function maximum execution time in seconds.

schedulestring

Schedule CRON syntax.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'https://appwrite.io/v1/functions' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}