Appwrite Functions API
The Functions Service allows you view, create and manage your Cloud Functions. 28 operations across 18 paths in the Appwrite 2.0.0 OpenAPI.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/appwrite-functions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.0.0
info:
title: Appwrite Functions API
description: Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
version: 2.0.0
termsOfService: https://appwrite.io/policy/terms
contact:
name: Appwrite Team
url: https://appwrite.io/support
email: team@appwrite.io
license:
name: BSD-3-Clause
url: https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE
servers:
- url: https://cloud.appwrite.io/v1
description: Appwrite Cloud endpoint.
- url: https://{region}.cloud.appwrite.io/v1
description: Appwrite Cloud regional endpoint. Replace `{region}` with your project region.
variables:
region:
default: fra
description: Appwrite Cloud region.
tags:
- name: functions
description: The Functions Service allows you view, create and manage your Cloud Functions.
paths:
/functions:
get:
summary: List functions
operationId: functionsList
tags:
- functions
description: Get a list of all the project's functions. You can use the query params to filter your results.
responses:
'200':
description: Functions List
content:
application/json:
schema:
$ref: '#/components/schemas/functionList'
deprecated: false
x-appwrite:
group: functions
demo: functions/list.md
rate-limit: 0
rate-time: 3600
rate-key: url:{url},ip:{ip}
scope: functions.read
platforms:
- console
- server
packaging: false
public: true
auth:
console:
Project: []
server:
Project: []
Key: []
security:
- Project: []
Key: []
parameters:
- name: queries
description: 'Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId'
required: false
schema:
type: array
items:
type: string
default: []
in: query
- name: search
description: 'Search term to filter your list results. Max length: 256 chars.'
required: false
schema:
type: string
example: <SEARCH>
default: ''
in: query
- name: total
description: When set to false, the total count returned will be 0 and will not be calculated.
required: false
schema:
type: boolean
example: false
default: true
in: query
post:
summary: Create function
operationId: functionsCreate
tags:
- functions
description: Create a new function. You can pass a list of [permissions](https://appwrite.io/docs/permissions) to allow different project users or team with access to execute the function using the client API.
responses:
'201':
description: Function
content:
application/json:
schema:
$ref: '#/components/schemas/function'
deprecated: false
x-appwrite:
group: functions
demo: functions/create.md
rate-limit: 0
rate-time: 3600
rate-key: url:{url},ip:{ip}
scope: functions.write
platforms:
- console
- server
packaging: false
public: true
auth:
console:
Project: []
server:
Project: []
Key: []
security:
- Project: []
Key: []
requestBody:
content:
application/json:
schema:
type: object
properties:
functionId:
description: 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.
type: string
example: <FUNCTION_ID>
x-appwrite:
idGenerator: ID.unique
name:
description: 'Function name. Max length: 128 chars.'
type: string
example: <NAME>
runtime:
description: Execution runtime.
type: string
example: node-14.5
title: Runtime
oneOf:
- type: string
enum:
- node-14.5
title: node-14.5
- type: string
enum:
- node-16.0
title: node-16.0
- type: string
enum:
- node-18.0
title: node-18.0
- type: string
enum:
- node-19.0
title: node-19.0
- type: string
enum:
- node-20.0
title: node-20.0
- type: string
enum:
- node-21.0
title: node-21.0
- type: string
enum:
- node-22
title: node-22
- type: string
enum:
- node-23
title: node-23
- type: string
enum:
- node-24
title: node-24
- type: string
enum:
- node-25
title: node-25
- type: string
enum:
- node-26
title: node-26
- type: string
enum:
- php-8.0
title: php-8.0
- type: string
enum:
- php-8.1
title: php-8.1
- type: string
enum:
- php-8.2
title: php-8.2
- type: string
enum:
- php-8.3
title: php-8.3
- type: string
enum:
- php-8.4
title: php-8.4
- type: string
enum:
- ruby-3.0
title: ruby-3.0
- type: string
enum:
- ruby-3.1
title: ruby-3.1
- type: string
enum:
- ruby-3.2
title: ruby-3.2
- type: string
enum:
- ruby-3.3
title: ruby-3.3
- type: string
enum:
- ruby-3.4
title: ruby-3.4
- type: string
enum:
- ruby-4.0
title: ruby-4.0
- type: string
enum:
- python-3.8
title: python-3.8
- type: string
enum:
- python-3.9
title: python-3.9
- type: string
enum:
- python-3.10
title: python-3.10
- type: string
enum:
- python-3.11
title: python-3.11
- type: string
enum:
- python-3.12
title: python-3.12
- type: string
enum:
- python-3.13
title: python-3.13
- type: string
enum:
- python-3.14
title: python-3.14
- type: string
enum:
- python-ml-3.11
title: python-ml-3.11
- type: string
enum:
- python-ml-3.12
title: python-ml-3.12
- type: string
enum:
- python-ml-3.13
title: python-ml-3.13
- type: string
enum:
- deno-1.21
title: deno-1.21
- type: string
enum:
- deno-1.24
title: deno-1.24
- type: string
enum:
- deno-1.35
title: deno-1.35
- type: string
enum:
- deno-1.40
title: deno-1.40
- type: string
enum:
- deno-1.46
title: deno-1.46
- type: string
enum:
- deno-2.0
title: deno-2.0
- type: string
enum:
- deno-2.5
title: deno-2.5
- type: string
enum:
- deno-2.6
title: deno-2.6
- type: string
enum:
- dart-2.15
title: dart-2.15
- type: string
enum:
- dart-2.16
title: dart-2.16
- type: string
enum:
- dart-2.17
title: dart-2.17
- type: string
enum:
- dart-2.18
title: dart-2.18
- type: string
enum:
- dart-2.19
title: dart-2.19
- type: string
enum:
- dart-3.0
title: dart-3.0
- type: string
enum:
- dart-3.1
title: dart-3.1
- type: string
enum:
- dart-3.3
title: dart-3.3
- type: string
enum:
- dart-3.5
title: dart-3.5
- type: string
enum:
- dart-3.8
title: dart-3.8
- type: string
enum:
- dart-3.9
title: dart-3.9
- type: string
enum:
- dart-3.10
title: dart-3.10
- type: string
enum:
- dart-3.11
title: dart-3.11
- type: string
enum:
- dart-3.12
title: dart-3.12
- type: string
enum:
- dart-3.13
title: dart-3.13
- type: string
enum:
- dotnet-6.0
title: dotnet-6.0
- type: string
enum:
- dotnet-7.0
title: dotnet-7.0
- type: string
enum:
- dotnet-8.0
title: dotnet-8.0
- type: string
enum:
- dotnet-10
title: dotnet-10
- type: string
enum:
- java-8.0
title: java-8.0
- type: string
enum:
- java-11.0
title: java-11.0
- type: string
enum:
- java-17.0
title: java-17.0
- type: string
enum:
- java-18.0
title: java-18.0
- type: string
enum:
- java-21.0
title: java-21.0
- type: string
enum:
- java-22
title: java-22
- type: string
enum:
- java-25
title: java-25
- type: string
enum:
- swift-5.5
title: swift-5.5
- type: string
enum:
- swift-5.8
title: swift-5.8
- type: string
enum:
- swift-5.9
title: swift-5.9
- type: string
enum:
- swift-5.10
title: swift-5.10
- type: string
enum:
- swift-6.2
title: swift-6.2
- type: string
enum:
- kotlin-1.6
title: kotlin-1.6
- type: string
enum:
- kotlin-1.8
title: kotlin-1.8
- type: string
enum:
- kotlin-1.9
title: kotlin-1.9
- type: string
enum:
- kotlin-2.0
title: kotlin-2.0
- type: string
enum:
- kotlin-2.3
title: kotlin-2.3
- type: string
enum:
- cpp-17
title: cpp-17
- type: string
enum:
- cpp-20
title: cpp-20
- type: string
enum:
- bun-1.0
title: bun-1.0
- type: string
enum:
- bun-1.1
title: bun-1.1
- type: string
enum:
- bun-1.2
title: bun-1.2
- type: string
enum:
- bun-1.3
title: bun-1.3
- type: string
enum:
- bun-1.4
title: bun-1.4
- type: string
enum:
- go-1.23
title: go-1.23
- type: string
enum:
- go-1.24
title: go-1.24
- type: string
enum:
- go-1.25
title: go-1.25
- type: string
enum:
- go-1.26
title: go-1.26
- type: string
enum:
- rust-1.83
title: rust-1.83
- type: string
enum:
- static-1
title: static-1
- type: string
enum:
- flutter-3.24
title: flutter-3.24
- type: string
enum:
- flutter-3.27
title: flutter-3.27
- type: string
enum:
- flutter-3.29
title: flutter-3.29
- type: string
enum:
- flutter-3.32
title: flutter-3.32
- type: string
enum:
- flutter-3.35
title: flutter-3.35
- type: string
enum:
- flutter-3.38
title: flutter-3.38
- type: string
enum:
- flutter-3.41
title: flutter-3.41
- type: string
enum:
- flutter-3.44
title: flutter-3.44
- type: string
enum:
- flutter-3.47
title: flutter-3.47
execute:
description: An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
type: array
default: []
example:
- any
items:
type: string
events:
description: Events list. Maximum of 100 events are allowed.
type: array
default: []
items:
type: string
schedule:
description: Schedule CRON syntax.
type: string
default: ''
example: 0 0 * * *
timeout:
description: Function maximum execution time in seconds.
type: integer
default: 15
example: 1
format: int32
enabled:
description: 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.
type: boolean
default: true
example: false
logging:
description: When disabled, executions will exclude logs and errors, and will be slightly faster.
type: boolean
default: true
example: false
entrypoint:
description: Entrypoint File. This path is relative to the "providerRootDirectory".
type: string
default: ''
example: <ENTRYPOINT>
commands:
description: Build Commands.
type: string
default: ''
example: <COMMANDS>
scopes:
description: List of scopes allowed for API key auto-generated for every execution. Maximum of 200 scopes are allowed.
type: array
default: []
items:
title: ProjectKeyScopes
type: string
oneOf:
- type: string
enum:
- project.read
title: project.read
- type: string
enum:
- project.write
title: project.write
- type: string
enum:
- usage.read
title: usage.read
- type: string
enum:
- keys.read
title: keys.read
- type: string
enum:
- keys.write
title: keys.write
- type: string
enum:
- platforms.read
title: platforms.read
- type: string
enum:
- platforms.write
title: platforms.write
- type: string
enum:
- mocks.read
title: mocks.read
- type: string
enum:
- mocks.write
title: mocks.write
- type: string
enum:
- policies.read
title: policies.read
- type: string
enum:
- policies.write
title: policies.write
- type: string
enum:
- project.policies.read
title: project.policies.read
- type: string
enum:
- project.policies.write
title: project.policies.write
- type: string
enum:
- project.oauth2.read
title: project.oauth2.read
- type: string
enum:
- project.oauth2.write
title: project.oauth2.write
- type: string
enum:
- templates.read
title: templates.read
- type: string
enum:
- templates.write
title: templates.write
- type: string
enum:
- stages.read
title: stages.read
- type: string
enum:
- stages.write
title: stages.write
- type: string
enum:
- users.read
title: users.read
- type: string
enum:
- users.write
title: users.write
- type: string
enum:
- sessions.read
title: sessions.read
- type: string
enum:
- sessions.write
title: sessions.write
- type: string
enum:
- teams.read
title: teams.read
- type: string
enum:
- teams.write
title: teams.write
- type: string
enum:
- databases.read
title: databases.read
- type: string
enum:
- databases.write
title: databases.write
- type: string
enum:
- tables.read
title: tables.read
- type: string
enum:
- tables.write
title: tables.write
- type: string
enum:
- columns.read
title: columns.read
- type: string
enum:
- columns.write
title: columns.write
- type: string
enum:
- indexes.read
title: indexes.read
- type: string
enum:
- indexes.write
title: indexes.write
- type: string
enum:
- rows.read
title: rows.read
- type: string
enum:
- rows.write
title: rows.write
- type: string
enum:
- embeddings.write
title: embeddings.write
- type: string
enum:
- collections.read
title: collections.read
- type: string
enum:
- collections.write
title: collections.write
- type: string
enum:
- attributes.read
title: attributes.read
- type: string
enum:
- attributes.write
title: attributes.write
- type: string
enum:
- documents.read
title: documents.read
- type: string
enum:
- documents.write
title: documents.write
- type: string
enum:
- documentsdb.read
title: documentsdb.read
- type: string
enum:
- documentsdb.write
title: documentsdb.write
- type: string
enum:
- documentsdb.collections.read
title: documentsdb.collections.read
- type: string
enum:
- documentsdb.collections.write
title: documentsdb.collections.write
- type: string
enum:
- documentsdb.documents.read
title: documentsdb.documents.read
- type: string
enum:
- documentsdb.documents.write
title: documentsdb.documents.write
- type: string
enum:
- documentsdb.indexes.read
title: documentsdb.indexes.read
- type: string
enum:
- documentsdb.indexes.write
title: documentsdb.indexes.write
- type: string
enum:
- vectorsdb.read
title: vectorsdb.read
- type: string
enum:
- vectorsdb.write
title: vectorsdb.write
- type: string
enum:
- vectorsdb.collections.read
title: vectorsdb.collections.read
- type: string
enum:
- vectorsdb.collections.write
title: vectorsdb.collections.write
- type: string
enum:
- vectorsdb.documents.read
title: vectorsdb.documents.read
- type: string
enum:
- vectorsdb.documents.write
title: vectorsdb.documents.write
- type: string
enum:
- vectorsdb.indexes.read
title: vectorsdb.indexes.read
- type: string
enum:
- vectorsdb.indexes.write
title: vectorsdb.indexes.write
- type: string
enum:
- buckets.read
title: buckets.read
- type: string
enum:
- buckets.write
title: buckets.write
- type: string
enum:
- files.read
title: files.read
- type: string
enum:
- files.write
title: files.write
- type: string
enum:
- tokens.read
title: tokens.read
- type: string
enum:
- tokens.write
title: tokens.write
- type: string
enum:
- functions.read
title: functions.read
- type: string
enum:
- functions.write
title: functions.write
- type: string
enum:
- executions.read
title: executions.read
- type: string
enum:
- executions.write
title: executions.write
- type: string
enum:
- execution.read
title: execution.read
- type: string
enum:
- execution.write
title: execution.write
- type: string
enum:
- sites.read
title: sites.read
- type: string
enum:
- sites.write
title: sites.write
- type: string
enum:
- log.read
title: log.read
- type: string
enum:
- log.write
title: log.write
- type: string
enum:
- providers.read
title: providers.read
- type: string
enum:
- providers.write
title: providers.write
- type: string
enum:
- topics.read
title: topics.read
- type: string
enum:
- topics.write
title: topics.write
- type: string
enum:
- subscribers.read
title: subscribers.read
- type: string
enum:
- subscribers.write
title: subscribers.write
- type: string
enum:
- targets.read
title: targets.read
- type: string
enum:
- targets.write
title: targets.write
- type: string
enum:
- messages.read
title: messages.read
- type: string
enum:
- messages.write
title: messages.write
- type: string
enum:
- rules.read
title: rules.read
- type: string
enum:
- rules.write
title: rules.write
- type: string
enum:
- webhoo
# --- truncated at 32 KB (163 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/openapi/appwrite-functions-api-openapi.yml