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.
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
GET /functions
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
FunctionList result = await functions.list(
queries: [], // (optional)
search: '<SEARCH>', // (optional)
);
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 requiredFunction 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 requiredFunction name. Max length: 128 chars.
runtime string requiredExecution 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.
scopes array List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.
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.
templateVersion string Version (tag) for the repo linked to the function template.
specification string Runtime specification for the function and builds.
Response
201 application/json
POST /functions
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
Func result = await functions.create(
functionId: '<FUNCTION_ID>',
name: '<NAME>',
runtime: .node145,
execute: ["any"], // (optional)
events: [], // (optional)
schedule: '', // (optional)
timeout: 1, // (optional)
enabled: false, // (optional)
logging: false, // (optional)
entrypoint: '<ENTRYPOINT>', // (optional)
commands: '<COMMANDS>', // (optional)
scopes: [], // (optional)
installationId: '<INSTALLATION_ID>', // (optional)
providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // (optional)
providerBranch: '<PROVIDER_BRANCH>', // (optional)
providerSilentMode: false, // (optional)
providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // (optional)
templateRepository: '<TEMPLATE_REPOSITORY>', // (optional)
templateOwner: '<TEMPLATE_OWNER>', // (optional)
templateRootDirectory: '<TEMPLATE_ROOT_DIRECTORY>', // (optional)
templateVersion: '<TEMPLATE_VERSION>', // (optional)
specification: '', // (optional)
);
List runtimes
Get a list of all runtimes that are currently active on your instance.
Response
200 application/json
GET /functions/runtimes
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
RuntimeList result = await functions.listRuntimes();
List available function runtime specifications
List allowed function specifications for this instance.
Response
200 application/json
GET /functions/specifications
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
SpecificationList result = await functions.listSpecifications();
Get function
Get a function by its unique ID.
Request
functionId string requiredFunction ID.
Response
200 application/json
GET /functions/{functionId}
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
Func result = await functions.get(
functionId: '<FUNCTION_ID>',
);
Update function
Update function by its unique ID.
Request
functionId string requiredFunction ID.
name string requiredFunction 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.
scopes array List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.
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.
specification string Runtime specification for the function and builds.
Response
200 application/json
PUT /functions/{functionId}
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
Func result = await functions.update(
functionId: '<FUNCTION_ID>',
name: '<NAME>',
runtime: .node145, // (optional)
execute: ["any"], // (optional)
events: [], // (optional)
schedule: '', // (optional)
timeout: 1, // (optional)
enabled: false, // (optional)
logging: false, // (optional)
entrypoint: '<ENTRYPOINT>', // (optional)
commands: '<COMMANDS>', // (optional)
scopes: [], // (optional)
installationId: '<INSTALLATION_ID>', // (optional)
providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // (optional)
providerBranch: '<PROVIDER_BRANCH>', // (optional)
providerSilentMode: false, // (optional)
providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // (optional)
specification: '', // (optional)
);
Delete function
Delete a function by its unique ID.
Request
functionId string requiredFunction ID.
Response
204 application/json
DELETE /functions/{functionId}
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
await functions.delete(
functionId: '<FUNCTION_ID>',
);
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 requiredFunction 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, type, size
search string Search term to filter your list results. Max length: 256 chars.
Response
200 application/json
GET /functions/{functionId}/deployments
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
DeploymentList result = await functions.listDeployments(
functionId: '<FUNCTION_ID>',
queries: [], // (optional)
search: '<SEARCH>', // (optional)
);
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 requiredFunction ID.
code string requiredGzip 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 requiredAutomatically activate the deployment when it is finished building.
entrypoint string Entrypoint File.
commands string Build Commands.
Response
202 application/json
POST /functions/{functionId}/deployments
import 'dart:io';
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
Deployment result = await functions.createDeployment(
functionId: '<FUNCTION_ID>',
code: InputFile(path: './path-to-files/image.jpg', filename: 'image.jpg'),
activate: false,
entrypoint: '<ENTRYPOINT>', // (optional)
commands: '<COMMANDS>', // (optional)
);
Get deployment
Get a code deployment by its unique ID.
Request
functionId string requiredFunction ID.
deploymentId string requiredDeployment ID.
Response
200 application/json
GET /functions/{functionId}/deployments/{deploymentId}
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
Deployment result = await functions.getDeployment(
functionId: '<FUNCTION_ID>',
deploymentId: '<DEPLOYMENT_ID>',
);
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 requiredFunction ID.
deploymentId string requiredDeployment ID.
Response
200 application/json
PATCH /functions/{functionId}/deployments/{deploymentId}
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
Func result = await functions.updateDeployment(
functionId: '<FUNCTION_ID>',
deploymentId: '<DEPLOYMENT_ID>',
);
Delete deployment
Delete a code deployment by its unique ID.
Request
functionId string requiredFunction ID.
deploymentId string requiredDeployment ID.
Response
204 application/json
DELETE /functions/{functionId}/deployments/{deploymentId}
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
await functions.deleteDeployment(
functionId: '<FUNCTION_ID>',
deploymentId: '<DEPLOYMENT_ID>',
);
Rebuild deployment
Request
functionId string requiredFunction ID.
deploymentId string requiredDeployment ID.
buildId string Build unique ID.
Response
204 application/json
POST /functions/{functionId}/deployments/{deploymentId}/build
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
result = await functions.createBuild(
functionId: '<FUNCTION_ID>',
deploymentId: '<DEPLOYMENT_ID>',
buildId: '<BUILD_ID>', // (optional)
);
Cancel deployment
Request
functionId string requiredFunction ID.
deploymentId string requiredDeployment ID.
Response
200 application/json
PATCH /functions/{functionId}/deployments/{deploymentId}/build
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
Build result = await functions.updateDeploymentBuild(
functionId: '<FUNCTION_ID>',
deploymentId: '<DEPLOYMENT_ID>',
);
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 requiredFunction ID.
deploymentId string requiredDeployment ID.
Response
200 application/json
GET /functions/{functionId}/deployments/{deploymentId}/download
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
UInt8List result = await functions.getDeploymentDownload(
functionId: '<FUNCTION_ID>',
deploymentId: '<DEPLOYMENT_ID>',
);
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 requiredFunction 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, requestMethod, requestPath, deploymentId
search string Search term to filter your list results. Max length: 256 chars.
Response
200 application/json
GET /functions/{functionId}/executions
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
Functions functions = Functions(client);
ExecutionList result = await functions.listExecutions(
functionId: '<FUNCTION_ID>',
queries: [], // (optional)
search: '<SEARCH>', // (optional)
);
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 requiredFunction 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 string HTTP headers of execution. Defaults to empty.
scheduledAt string Scheduled execution time in ISO 8601 format. DateTime value must be in future with precision in minutes.
Response
201 application/json
POST /functions/{functionId}/executions
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
Functions functions = Functions(client);
Execution result = await functions.createExecution(
functionId: '<FUNCTION_ID>',
body: '<BODY>', // (optional)
xasync: false, // (optional)
path: '<PATH>', // (optional)
method: ExecutionMethod.gET, // (optional)
headers: {}, // (optional)
scheduledAt: '', // (optional)
);
Get execution
Get a function execution log by its unique ID.
Request
functionId string requiredFunction ID.
executionId string requiredExecution ID.
Response
200 application/json
GET /functions/{functionId}/executions/{executionId}
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
Functions functions = Functions(client);
Execution result = await functions.getExecution(
functionId: '<FUNCTION_ID>',
executionId: '<EXECUTION_ID>',
);
Delete execution
Delete a function execution by its unique ID.
Request
functionId string requiredFunction ID.
executionId string requiredExecution ID.
Response
204 application/json
DELETE /functions/{functionId}/executions/{executionId}
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
await functions.deleteExecution(
functionId: '<FUNCTION_ID>',
executionId: '<EXECUTION_ID>',
);
List variables
Get a list of all variables of a specific function.
Request
functionId string requiredFunction unique ID.
Response
200 application/json
GET /functions/{functionId}/variables
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
VariableList result = await functions.listVariables(
functionId: '<FUNCTION_ID>',
);
Create variable
Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.
Request
functionId string requiredFunction unique ID.
key string requiredVariable key. Max length: 255 chars.
value string requiredVariable value. Max length: 8192 chars.
Response
201 application/json
POST /functions/{functionId}/variables
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
Variable result = await functions.createVariable(
functionId: '<FUNCTION_ID>',
key: '<KEY>',
value: '<VALUE>',
);
Get variable
Get a variable by its unique ID.
Request
functionId string requiredFunction unique ID.
variableId string requiredVariable unique ID.
Response
200 application/json
GET /functions/{functionId}/variables/{variableId}
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
Variable result = await functions.getVariable(
functionId: '<FUNCTION_ID>',
variableId: '<VARIABLE_ID>',
);
Update variable
Update variable by its unique ID.
Request
functionId string requiredFunction unique ID.
variableId string requiredVariable unique ID.
key string requiredVariable key. Max length: 255 chars.
value string Variable value. Max length: 8192 chars.
Response
200 application/json
PUT /functions/{functionId}/variables/{variableId}
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
Variable result = await functions.updateVariable(
functionId: '<FUNCTION_ID>',
variableId: '<VARIABLE_ID>',
key: '<KEY>',
value: '<VALUE>', // (optional)
);
Delete variable
Delete a variable by its unique ID.
Request
functionId string requiredFunction unique ID.
variableId string requiredVariable unique ID.
Response
204 application/json
DELETE /functions/{functionId}/variables/{variableId}
import 'package:dart_appwrite/dart_appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setKey('<YOUR_API_KEY>'); // Your secret API key
Functions functions = Functions(client);
await functions.deleteVariable(
functionId: '<FUNCTION_ID>',
variableId: '<VARIABLE_ID>',
);