Databases 42 endpoints

GET /databases List databases

Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.

operationId: Databases_listAll

Parameters

Name	In	Required	Type	Description
queries	query	optional	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
search	query	optional	string	Search term to filter your list results. Max length: 256 chars.

Responses

200

Databases List

GET /databases

POST /databases Create database

Create a new Database.

operationId: Databases_createDatabase

Request Body

application/json

schema DatabasesCreateDatabaseRequest

Property	Type	Required
name	string	required
enabled	boolean	optional
databaseId	string	required

Responses

201

Database

POST /databases

DELETE /databases/{databaseId} Delete database

Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.

operationId: Databases_deleteById

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.

Responses

204

No content

DELETE /databases/{databaseId}

GET /databases/{databaseId} Get database

Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.

operationId: Databases_getById

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.

Responses

200

Database

GET /databases/{databaseId}

PUT /databases/{databaseId} Update database

Update a database by its unique ID.

operationId: Databases_updateById

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.

Request Body

application/json

schema DatabasesUpdateByIdRequest

Property	Type	Required
name	string	required
enabled	boolean	optional

Responses

200

Database

PUT /databases/{databaseId}

GET /databases/{databaseId}/collections List collections

Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.

operationId: Databases_listCollections

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
queries	query	optional	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, documentSecurity
search	query	optional	string	Search term to filter your list results. Max length: 256 chars.

Responses

200

Collections List

GET /databases/{databaseId}/collections

POST /databases/{databaseId}/collections Create collection

Create a new Collection. Before using this route, you should create a new database resource using either a server integration API or directly from your database console.

operationId: Databases_createCollection

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.

Request Body

application/json

schema DatabasesCreateCollectionRequest

Property	Type	Required
name	string	required
enabled	boolean	optional
permissions	array	optional
collectionId	string	required
documentSecurity	boolean	optional

Responses

201

Collection

POST /databases/{databaseId}/collections

DELETE /databases/{databaseId}/collections/{collectionId} Delete collection

Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.

operationId: Databases_deleteCollectionById

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID.

Responses

204

No content

DELETE /databases/{databaseId}/collections/{collectionId}

GET /databases/{databaseId}/collections/{collectionId} Get collection

Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.

operationId: Databases_getCollectionById

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID.

Responses

200

Collection

GET /databases/{databaseId}/collections/{collectionId}

PUT /databases/{databaseId}/collections/{collectionId} Update collection

Update a collection by its unique ID.

operationId: Databases_updateCollectionById

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID.

Request Body

application/json

schema DatabasesUpdateCollectionByIdRequest

Property	Type	Required
name	string	required
enabled	boolean	optional
permissions	array	optional
documentSecurity	boolean	optional

Responses

200

Collection

PUT /databases/{databaseId}/collections/{collectionId}

GET /databases/{databaseId}/collections/{collectionId}/attributes List attributes

List attributes in the collection.

operationId: Databases_listCollectionAttributes

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
queries	query	optional	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: key, type, size, required, array, status, error

Responses

200

Attributes List

GET /databases/{databaseId}/collections/{collectionId}/attributes

POST /databases/{databaseId}/collections/{collectionId}/attributes/boolean Create boolean attribute

Create a boolean attribute.

operationId: Databases_createBooleanAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.

Request Body

application/json

schema DatabasesCreateBooleanAttributeRequest

Property	Type	Required
key	string	required
array	boolean	optional
default	boolean	optional
required	boolean	required

Responses

202

AttributeBoolean

POST /databases/{databaseId}/collections/{collectionId}/attributes/boolean

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key} Update boolean attribute

Update a boolean attribute. Changing the default value will not update already existing documents.

operationId: Databases_updateBooleanAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Attribute Key.

Request Body

application/json

schema DatabasesUpdateBooleanAttributeRequest

Property	Type	Required
default	boolean	required
required	boolean	required

Responses

200

AttributeBoolean

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}

POST /databases/{databaseId}/collections/{collectionId}/attributes/datetime Create datetime attribute

Create a date time attribute according to the ISO 8601 standard.

operationId: Databases_createDatetimeAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.

Request Body

application/json

schema DatabasesCreateDatetimeAttributeRequest

Property	Type	Required
key	string	required
array	boolean	optional
default	string	optional
required	boolean	required

Responses

202

AttributeDatetime

POST /databases/{databaseId}/collections/{collectionId}/attributes/datetime

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key} Update dateTime attribute

Update a date time attribute. Changing the default value will not update already existing documents.

operationId: Databases_updateDatetimeAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Attribute Key.

Request Body

application/json

schema DatabasesUpdateDatetimeAttributeRequest

Property	Type	Required
default	string	required
required	boolean	required

Responses

200

AttributeDatetime

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}

POST /databases/{databaseId}/collections/{collectionId}/attributes/email Create email attribute

Create an email attribute.

operationId: Databases_createEmailAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.

Request Body

application/json

schema DatabasesCreateEmailAttributeRequest

Property	Type	Required
key	string	required
array	boolean	optional
default	string	optional
required	boolean	required

Responses

202

AttributeEmail

POST /databases/{databaseId}/collections/{collectionId}/attributes/email

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/email/{key} Update email attribute

Update an email attribute. Changing the default value will not update already existing documents.

operationId: Databases_updateEmailAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Attribute Key.

Request Body

application/json

schema DatabasesUpdateEmailAttributeRequest

Property	Type	Required
default	string	required
required	boolean	required

Responses

200

AttributeEmail

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/email/{key}

POST /databases/{databaseId}/collections/{collectionId}/attributes/enum Create enum attribute

Create an enumeration attribute. The elements param acts as a white-list of accepted values for this attribute.

operationId: Databases_createEnumAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.

Request Body

application/json

schema DatabasesCreateEnumAttributeRequest

Property	Type	Required
key	string	required
array	boolean	optional
default	string	optional
elements	array	required
required	boolean	required

Responses

202

AttributeEnum

POST /databases/{databaseId}/collections/{collectionId}/attributes/enum

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/enum/{key} Update enum attribute

Update an enum attribute. Changing the default value will not update already existing documents.

operationId: Databases_updateEnumAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Attribute Key.

Request Body

application/json

schema DatabasesUpdateEnumAttributeRequest

Property	Type	Required
default	string	required
elements	array	required
required	boolean	required

Responses

200

AttributeEnum

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}

POST /databases/{databaseId}/collections/{collectionId}/attributes/float Create float attribute

Create a float attribute. Optionally, minimum and maximum values can be provided.

operationId: Databases_createFloatAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.

Request Body

application/json

schema DatabasesCreateFloatAttributeRequest

Property	Type	Required
key	string	required
max	number	optional
min	number	optional
array	boolean	optional
default	number	optional
required	boolean	required

Responses

202

AttributeFloat

POST /databases/{databaseId}/collections/{collectionId}/attributes/float

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/float/{key} Update float attribute

Update a float attribute. Changing the default value will not update already existing documents.

operationId: Databases_updateFloatAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Attribute Key.

Request Body

application/json

schema DatabasesUpdateFloatAttributeRequest

Property	Type	Required
max	number	required
min	number	required
default	number	required
required	boolean	required

Responses

200

AttributeFloat

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/float/{key}

POST /databases/{databaseId}/collections/{collectionId}/attributes/integer Create integer attribute

Create an integer attribute. Optionally, minimum and maximum values can be provided.

operationId: Databases_createIntegerAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.

Request Body

application/json

schema DatabasesCreateIntegerAttributeRequest

Property	Type	Required
key	string	required
max	integer	optional
min	integer	optional
array	boolean	optional
default	integer	optional
required	boolean	required

Responses

202

AttributeInteger

POST /databases/{databaseId}/collections/{collectionId}/attributes/integer

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/integer/{key} Update integer attribute

Update an integer attribute. Changing the default value will not update already existing documents.

operationId: Databases_updateIntegerAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Attribute Key.

Request Body

application/json

schema DatabasesUpdateIntegerAttributeRequest

Property	Type	Required
max	integer	required
min	integer	required
default	integer	required
required	boolean	required

Responses

200

AttributeInteger

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}

POST /databases/{databaseId}/collections/{collectionId}/attributes/ip Create IP address attribute

Create IP address attribute.

operationId: Databases_createIpAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.

Request Body

application/json

schema DatabasesCreateIpAttributeRequest

Property	Type	Required
key	string	required
array	boolean	optional
default	string	optional
required	boolean	required

Responses

202

AttributeIP

POST /databases/{databaseId}/collections/{collectionId}/attributes/ip

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/ip/{key} Update IP address attribute

Update an ip attribute. Changing the default value will not update already existing documents.

operationId: Databases_updateIpAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Attribute Key.

Request Body

application/json

schema DatabasesUpdateIpAttributeRequest

Property	Type	Required
default	string	required
required	boolean	required

Responses

200

AttributeIP

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}

POST /databases/{databaseId}/collections/{collectionId}/attributes/relationship Create relationship attribute

Create relationship attribute. Learn more about relationship attributes.

operationId: Databases_createRelationshipAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.

Request Body

application/json

schema DatabasesCreateRelationshipAttributeRequest

Property	Type	Required
key	string	optional
type	string	required
twoWay	boolean	optional
onDelete	string	optional
twoWayKey	string	optional
relatedCollectionId	string	required

Responses

202

AttributeRelationship

POST /databases/{databaseId}/collections/{collectionId}/attributes/relationship

POST /databases/{databaseId}/collections/{collectionId}/attributes/string Create string attribute

Create a string attribute.

operationId: Databases_createStringAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.

Request Body

application/json

schema DatabasesCreateStringAttributeRequest

Property	Type	Required
key	string	required
size	integer	required
array	boolean	optional
default	string	optional
encrypt	boolean	optional
required	boolean	required

Responses

202

AttributeString

POST /databases/{databaseId}/collections/{collectionId}/attributes/string

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/string/{key} Update string attribute

Update a string attribute. Changing the default value will not update already existing documents.

operationId: Databases_updateStringAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Attribute Key.

Request Body

application/json

schema DatabasesUpdateStringAttributeRequest

Property	Type	Required
default	string	required
required	boolean	required

Responses

200

AttributeString

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/string/{key}

POST /databases/{databaseId}/collections/{collectionId}/attributes/url Create URL attribute

Create a URL attribute.

operationId: Databases_createUrlAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.

Request Body

application/json

schema DatabasesCreateUrlAttributeRequest

Property	Type	Required
key	string	required
array	boolean	optional
default	string	optional
required	boolean	required

Responses

202

AttributeURL

POST /databases/{databaseId}/collections/{collectionId}/attributes/url

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/url/{key} Update URL attribute

Update an url attribute. Changing the default value will not update already existing documents.

operationId: Databases_updateUrlAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Attribute Key.

Request Body

application/json

schema DatabasesUpdateUrlAttributeRequest

Property	Type	Required
default	string	required
required	boolean	required

Responses

200

AttributeURL

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/url/{key}

DELETE /databases/{databaseId}/collections/{collectionId}/attributes/{key} Delete attribute

Deletes an attribute.

operationId: Databases_deleteAttributeById

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Attribute Key.

Responses

204

No content

DELETE /databases/{databaseId}/collections/{collectionId}/attributes/{key}

GET /databases/{databaseId}/collections/{collectionId}/attributes/{key} Get attribute

Get attribute by ID.

operationId: Databases_getAttributeById

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Attribute Key.

Responses

200

AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString

GET /databases/{databaseId}/collections/{collectionId}/attributes/{key}

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship Update relationship attribute

Update relationship attribute. Learn more about relationship attributes.

operationId: Databases_updateRelationshipAttribute

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Attribute Key.

Request Body

application/json

schema DatabasesUpdateRelationshipAttributeRequest

Property	Type	Required
onDelete	string	optional

Responses

200

AttributeRelationship

PATCH /databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship

GET /databases/{databaseId}/collections/{collectionId}/documents List documents

Get a list of all the user’s documents in a given collection. You can use the query params to filter your results.

operationId: Databases_listCollectionDocuments

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
queries	query	optional	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.

Responses

200

Documents List

GET /databases/{databaseId}/collections/{collectionId}/documents

POST /databases/{databaseId}/collections/{collectionId}/documents Create document

Create a new Document. Before using this route, you should create a new collection resource using either a server integration API or directly from your database console.

operationId: Databases_createDocument

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration. Make sure to define attributes before creating documents.

Request Body

application/json

schema DatabasesCreateDocumentRequest

Property	Type	Required
data	object	required
documentId	string	required
permissions	array	optional

Responses

201

Document

POST /databases/{databaseId}/collections/{collectionId}/documents

DELETE /databases/{databaseId}/collections/{collectionId}/documents/{documentId} Delete document

Delete a document by its unique ID.

operationId: Databases_deleteDocumentById

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
documentId	path	required	string	Document ID.

Responses

204

No content

DELETE /databases/{databaseId}/collections/{collectionId}/documents/{documentId}

GET /databases/{databaseId}/collections/{collectionId}/documents/{documentId} Get document

Get a document by its unique ID. This endpoint response returns a JSON object with the document data.

operationId: Databases_getDocumentById

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
documentId	path	required	string	Document ID.
queries	query	optional	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.

Responses

200

Document

GET /databases/{databaseId}/collections/{collectionId}/documents/{documentId}

PATCH /databases/{databaseId}/collections/{collectionId}/documents/{documentId} Update document

Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.

operationId: Databases_updateDocumentById

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID.
documentId	path	required	string	Document ID.

Request Body

application/json

schema DatabasesUpdateDocumentByIdRequest

Property	Type	Required
data	object	optional
permissions	array	optional

Responses

200

Document

PATCH /databases/{databaseId}/collections/{collectionId}/documents/{documentId}

GET /databases/{databaseId}/collections/{collectionId}/indexes List indexes

List indexes in the collection.

operationId: Databases_listIndexes

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
queries	query	optional	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: key, type, status, attributes, error

Responses

200

Indexes List

GET /databases/{databaseId}/collections/{collectionId}/indexes

POST /databases/{databaseId}/collections/{collectionId}/indexes Create index

Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.
Attributes can be key, fulltext, and unique.

operationId: Databases_createIndex

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.

Request Body

application/json

schema DatabasesCreateIndexRequest

Property	Type	Required
key	string	required
type	string	required
orders	array	optional
attributes	array	required

Responses

202

Index

POST /databases/{databaseId}/collections/{collectionId}/indexes

DELETE /databases/{databaseId}/collections/{collectionId}/indexes/{key} Delete index

Delete an index.

operationId: Databases_deleteIndex

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Index Key.

Responses

204

No content

DELETE /databases/{databaseId}/collections/{collectionId}/indexes/{key}

GET /databases/{databaseId}/collections/{collectionId}/indexes/{key} Get index

Get index by ID.

operationId: Databases_getIndexById

Parameters

Name	In	Required	Type	Description
databaseId	path	required	string	Database ID.
collectionId	path	required	string	Collection ID. You can create a new collection using the Database service server integration.
key	path	required	string	Index Key.

Responses

200

Index

GET /databases/{databaseId}/collections/{collectionId}/indexes/{key}

Functions 8 endpoints

GET /functions List functions

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

operationId: Functions_listAllFunctions

Parameters

Name	In	Required	Type	Description
queries	query	optional	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	query	optional	string	Search term to filter your list results. Max length: 256 chars.

Responses

200

Functions List

GET /functions

POST /functions 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.

operationId: Functions_createNewFunction

Request Body

application/json

schema FunctionsCreateNewFunctionRequest

Property	Type	Required
name	string	required
events	array	optional
enabled	boolean	optional
execute	array	optional
logging	boolean	optional
runtime	string	required
timeout	integer	optional
commands	string	optional
schedule	string	optional
entrypoint	string	optional
functionId	string	required
templateOwner	string	optional
installationId	string	optional
providerBranch	string	optional
templateBranch	string	optional
providerSilentMode	boolean	optional
templateRepository	string	optional
providerRepositoryId	string	optional
providerRootDirectory	string	optional
templateRootDirectory	string	optional

Responses

201

Function

POST /functions

GET /functions/runtimes List runtimes

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

operationId: Functions_listRuntimes

Responses

200

Runtimes List

GET /functions/runtimes

DELETE /functions/{functionId} Delete function

Delete a function by its unique ID.

operationId: Functions_deleteById

Parameters

Name	In	Required	Type	Description
functionId	path	required	string	Function ID.

Responses

204

No content

DELETE /functions/{functionId}

GET /functions/{functionId} Get function

Get a function by its unique ID.

operationId: Functions_getById

Parameters

Name	In	Required	Type	Description
functionId	path	required	string	Function ID.

Responses

200

Function

GET /functions/{functionId}

PUT /functions/{functionId} Update function

Update function by its unique ID.

operationId: Functions_updateById

Parameters

Name	In	Required	Type	Description
functionId	path	required	string	Function ID.

Request Body

application/json

schema FunctionsUpdateByIdRequest

Property	Type	Required
name	string	required
events	array	optional
enabled	boolean	optional
execute	array	optional
logging	boolean	optional
runtime	string	optional
timeout	integer	optional
commands	string	optional
schedule	string	optional
entrypoint	string	optional
installationId	string	optional
providerBranch	string	optional
providerSilentMode	boolean	optional
providerRepositoryId	string	optional
providerRootDirectory	string	optional

Responses

200

Function

PUT /functions/{functionId}

GET /functions/{functionId}/deployments List deployments

Get a list of all the project’s code deployments. You can use the query params to filter your results.

operationId: Functions_listDeployments

Parameters

Name	In	Required	Type	Description
functionId	path	required	string	Function ID.
queries	query	optional	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	query	optional	string	Search term to filter your list results. Max length: 256 chars.

Responses

200

Deployments List

GET /functions/{functionId}/deployments

POST /functions/{functionId}/deployments 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.

operationId: Functions_createDeploymentFunctionCode

Parameters

Name	In	Required	Type	Description
functionId	path	required	string	Function ID.

Request Body

multipart/form-data

schema FunctionsCreateDeploymentFunctionCodeRequest

Property	Type	Required
code	string	required
activate	boolean	required
commands	string	optional
entrypoint	string	optional

Responses

202

Deployment

POST /functions/{functionId}/deployments