Databases

SERVER

Platform

Version

The Databases service allows you to create structured collections of documents, query and filter lists of documents, and manage an advanced set of read and write access permissions.

All data returned by the Databases service are represented as structured JSON documents.

The Databases service can contain multiple databases, each database can contain multiple collections. A collection is a group of similarly structured documents. The accepted structure of documents is defined by collection attributes. The collection attributes help you ensure all your user-submitted data is validated and stored according to the collection structure.

Using Appwrite permissions architecture, you can assign read or write access to each collection or document in your project for either a specific user, team, user role, or even grant it with public access (any). You can learn more about how Appwrite handles permissions and access control.

Base URL

https://cloud.appwrite.io/v1

List databases

Get a list of all databases from the current Appwrite project. You can use the search parameter 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
- search string
  
  Search term to filter your list results. Max length: 256 chars.
Response
- 200 application/json
  
  Databases List

Endpoint

GET /databases

REST

GET /v1/databases HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Create database

Create a new Database.

Request
- databaseId string
  required
  
  Unique 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
  
  Database name. Max length: 128 chars.
- enabled boolean
  
  Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
Response
- 201 application/json
  
  Database

Endpoint

POST /databases

REST

POST /v1/databases HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "databaseId": "<DATABASE_ID>",
  "name": "<NAME>",
  "enabled": false
}

Get database

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

Request
- databaseId string
  required
  
  Database ID.
Response
- 200 application/json
  
  Database

Endpoint

GET /databases/{databaseId}

REST

GET /v1/databases/{databaseId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Update database

Update a database by its unique ID.

Request
- databaseId string
  required
  
  Database ID.
- name string
  required
  
  Database name. Max length: 128 chars.
- enabled boolean
  
  Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
Response
- 200 application/json
  
  Database

Endpoint

PUT /databases/{databaseId}

REST

PUT /v1/databases/{databaseId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "name": "<NAME>",
  "enabled": false
}

Delete database

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

Request
- databaseId string
  required
  
  Database ID.
Response
- 204 application/json

Endpoint

DELETE /databases/{databaseId}

REST

DELETE /v1/databases/{databaseId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

List collections

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

Request
- databaseId string
  required
  
  Database 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: name, enabled, documentSecurity
- search string
  
  Search term to filter your list results. Max length: 256 chars.
Response
- 200 application/json
  
  Collections List

Endpoint

GET /databases/{databaseId}/collections

REST

GET /v1/databases/{databaseId}/collections HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

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.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Unique 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
  
  Collection name. Max length: 128 chars.
- permissions array
  
  An array of permissions strings. By default, no user is granted with any permissions. Learn more about permissions.
- documentSecurity boolean
  
  Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. Learn more about permissions.
- enabled boolean
  
  Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
Response
- 201 application/json
  
  Collection

Endpoint

POST /databases/{databaseId}/collections

REST

POST /v1/databases/{databaseId}/collections HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "collectionId": "<COLLECTION_ID>",
  "name": "<NAME>",
  "permissions": ["read(\"any\")"],
  "documentSecurity": false,
  "enabled": false
}

Get collection

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID.
Response
- 200 application/json
  
  Collection

Endpoint

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

REST

GET /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Update collection

Update a collection by its unique ID.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID.
- name string
  required
  
  Collection name. Max length: 128 chars.
- permissions array
  
  An array of permission strings. By default, the current permissions are inherited. Learn more about permissions.
- documentSecurity boolean
  
  Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. Learn more about permissions.
- enabled boolean
  
  Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
Response
- 200 application/json
  
  Collection

Endpoint

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

REST

PUT /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "name": "<NAME>",
  "permissions": ["read(\"any\")"],
  "documentSecurity": false,
  "enabled": false
}

Delete collection

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID.
Response
- 204 application/json

Endpoint

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

REST

DELETE /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

List attributes

List attributes in the collection.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- 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: key, type, size, required, array, status, error
Response
- 200 application/json
  
  Attributes List

Endpoint

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

REST

GET /v1/databases/{databaseId}/collections/{collectionId}/attributes HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Create boolean attribute

Create a boolean attribute.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- default boolean
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- array boolean
  
  Is attribute an array?
Response
- 202 application/json
  
  AttributeBoolean

Endpoint

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

REST

POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/boolean HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "key": ,
  "required": false,
  "default": false,
  "array": false
}

Update boolean attribute

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- default boolean
  required
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- newKey string
  
  New attribute key.
Response
- 200 application/json

Endpoint

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

REST

PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "required": false,
  "default": false,
  "newKey": 
}

Create datetime attribute

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- default string
  
  Default value for the attribute in ISO 8601 format. Cannot be set when attribute is required.
- array boolean
  
  Is attribute an array?
Response
- 202 application/json
  
  AttributeDatetime

Endpoint

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

REST

POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/datetime HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "key": ,
  "required": false,
  "default": ,
  "array": false
}

Update dateTime attribute

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- default string
  required
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- newKey string
  
  New attribute key.
Response
- 200 application/json

Endpoint

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

REST

PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "required": false,
  "default": ,
  "newKey": 
}

Create email attribute

Create an email attribute.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- default string
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- array boolean
  
  Is attribute an array?
Response
- 202 application/json
  
  AttributeEmail

Endpoint

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

REST

POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/email HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "key": ,
  "required": false,
  "default": "email@example.com",
  "array": false
}

Update email attribute

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- default string
  required
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- newKey string
  
  New attribute key.
Response
- 200 application/json

Endpoint

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

REST

PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/email/{key} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "required": false,
  "default": "email@example.com",
  "newKey": 
}

Create enum attribute

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- elements array
  required
  
  Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.
- required boolean
  required
  
  Is attribute required?
- default string
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- array boolean
  
  Is attribute an array?
Response
- 202 application/json
  
  AttributeEnum

Endpoint

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

REST

POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/enum HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "key": ,
  "elements": [],
  "required": false,
  "default": "<DEFAULT>",
  "array": false
}

Update enum attribute

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- elements array
  required
  
  Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.
- required boolean
  required
  
  Is attribute required?
- default string
  required
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- newKey string
  
  New attribute key.
Response
- 200 application/json

Endpoint

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

REST

PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "elements": [],
  "required": false,
  "default": "<DEFAULT>",
  "newKey": 
}

Create float attribute

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- min number
  
  Minimum value to enforce on new documents
- max number
  
  Maximum value to enforce on new documents
- default number
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- array boolean
  
  Is attribute an array?
Response
- 202 application/json
  
  AttributeFloat

Endpoint

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

REST

POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/float HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "key": ,
  "required": false,
  "min": 0,
  "max": 0,
  "default": 0,
  "array": false
}

Update float attribute

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- min number
  required
  
  Minimum value to enforce on new documents
- max number
  required
  
  Maximum value to enforce on new documents
- default number
  required
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- newKey string
  
  New attribute key.
Response
- 200 application/json

Endpoint

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

REST

PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/float/{key} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "required": false,
  "min": 0,
  "max": 0,
  "default": 0,
  "newKey": 
}

Create integer attribute

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- min integer
  
  Minimum value to enforce on new documents
- max integer
  
  Maximum value to enforce on new documents
- default integer
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- array boolean
  
  Is attribute an array?
Response
- 202 application/json
  
  AttributeInteger

Endpoint

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

REST

POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/integer HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "key": ,
  "required": false,
  "min": 0,
  "max": 0,
  "default": 0,
  "array": false
}

Update integer attribute

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- min integer
  required
  
  Minimum value to enforce on new documents
- max integer
  required
  
  Maximum value to enforce on new documents
- default integer
  required
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- newKey string
  
  New attribute key.
Response
- 200 application/json

Endpoint

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

REST

PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "required": false,
  "min": 0,
  "max": 0,
  "default": 0,
  "newKey": 
}

Create IP address attribute

Create IP address attribute.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- default string
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- array boolean
  
  Is attribute an array?
Response
- 202 application/json
  
  AttributeIP

Endpoint

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

REST

POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/ip HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "key": ,
  "required": false,
  "default": ,
  "array": false
}

Update IP address attribute

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- default string
  required
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- newKey string
  
  New attribute key.
Response
- 200 application/json

Endpoint

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

REST

PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "required": false,
  "default": ,
  "newKey": 
}

Create relationship attribute

Create relationship attribute. Learn more about relationship attributes.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- relatedCollectionId string
  required
  
  Related Collection ID. You can create a new collection using the Database service server integration.
- type string
  required
  
  Relation type
- twoWay boolean
  
  Is Two Way?
- key string
  
  Attribute Key.
- twoWayKey string
  
  Two Way Attribute Key.
- onDelete string
  
  Constraints option
Response
- 202 application/json
  
  AttributeRelationship

Endpoint

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

REST

POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/relationship HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "relatedCollectionId": "<RELATED_COLLECTION_ID>",
  "type": "oneToOne",
  "twoWay": false,
  "key": ,
  "twoWayKey": ,
  "onDelete": "cascade"
}

Create string attribute

Create a string attribute.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- size integer
  required
  
  Attribute size for text attributes, in number of characters.
- required boolean
  required
  
  Is attribute required?
- default string
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- array boolean
  
  Is attribute an array?
- encrypt boolean
  
  Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
Response
- 202 application/json
  
  AttributeString

Endpoint

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

REST

POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/string HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "key": ,
  "size": 1,
  "required": false,
  "default": "<DEFAULT>",
  "array": false,
  "encrypt": false
}

Update string attribute

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- default string
  required
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- size integer
  
  Maximum size of the string attribute.
- newKey string
  
  New attribute key.
Response
- 200 application/json

Endpoint

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

REST

PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/string/{key} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "required": false,
  "default": "<DEFAULT>",
  "size": 0,
  "newKey": 
}

Create URL attribute

Create a URL attribute.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- default string
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- array boolean
  
  Is attribute an array?
Response
- 202 application/json
  
  AttributeURL

Endpoint

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

REST

POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/url HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "key": ,
  "required": false,
  "default": "https://example.com",
  "array": false
}

Update URL attribute

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- required boolean
  required
  
  Is attribute required?
- default string
  required
  
  Default value for attribute when not provided. Cannot be set when attribute is required.
- newKey string
  
  New attribute key.
Response
- 200 application/json

Endpoint

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

REST

PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/url/{key} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "required": false,
  "default": "https://example.com",
  "newKey": 
}

Get attribute

Get attribute by ID.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
Response
- 200 application/json
  
  AttributeBoolean
  AttributeInteger
  AttributeFloat
  AttributeEmail
  AttributeEnum
  AttributeURL
  AttributeIP
  AttributeDatetime
  AttributeRelationship
  AttributeString

Endpoint

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

REST

GET /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Delete attribute

Deletes an attribute.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
Response
- 204 application/json

Endpoint

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

REST

DELETE /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Update relationship attribute

Update relationship attribute. Learn more about relationship attributes.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Attribute Key.
- onDelete string
  
  Constraints option
- newKey string
  
  New attribute key.
Response
- 200 application/json

Endpoint

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

REST

PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "onDelete": "cascade",
  "newKey": 
}

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.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- 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.
Response
- 200 application/json
  
  Documents List

Endpoint

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

REST

GET /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Session: 
X-Appwrite-Key: <YOUR_API_KEY>
X-Appwrite-JWT: <YOUR_JWT>

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.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration. Make sure to define attributes before creating documents.
- documentId string
  required
  
  Document 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.
- data object
  required
  
  Document data as JSON object.
- permissions array
  
  An array of permissions strings. By default, only the current user is granted all permissions. Learn more about permissions.
Response
- 201 application/json
  
  Document
Rate limits

This endpoint is not limited when using Server SDKs with API keys. If you are using SSR with setSession, these rate limits will still apply. Learn more about SSR rate limits.

The limit is applied for each unique limit key.

Time frame

Attempts

Key

1 minutes 120 requests IP + METHOD + URL + USER ID

Learn more about rate limits

Time frame	Attempts	Key
1 minutes	120 requests	IP + METHOD + URL + USER ID

Endpoint

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

REST

POST /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Session: 
X-Appwrite-Key: <YOUR_API_KEY>
X-Appwrite-JWT: <YOUR_JWT>

{
  "documentId": "<DOCUMENT_ID>",
  "data": {},
  "permissions": ["read(\"any\")"]
}

Get document

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- documentId string
  required
  
  Document 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.
Response
- 200 application/json
  
  Document

Endpoint

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

REST

GET /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Session: 
X-Appwrite-Key: <YOUR_API_KEY>
X-Appwrite-JWT: <YOUR_JWT>

Update document

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

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID.
- documentId string
  required
  
  Document ID.
- data object
  
  Document data as JSON object. Include only attribute and value pairs to be updated.
- permissions array
  
  An array of permissions strings. By default, the current permissions are inherited. Learn more about permissions.
Response
- 200 application/json
  
  Document
Rate limits

This endpoint is not limited when using Server SDKs with API keys. If you are using SSR with setSession, these rate limits will still apply. Learn more about SSR rate limits.

The limit is applied for each unique limit key.

Time frame

Attempts

Key

1 minutes 120 requests IP + METHOD + URL + USER ID

Learn more about rate limits

Time frame	Attempts	Key
1 minutes	120 requests	IP + METHOD + URL + USER ID

Endpoint

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

REST

PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Session: 
X-Appwrite-Key: <YOUR_API_KEY>
X-Appwrite-JWT: <YOUR_JWT>

{
  "data": {},
  "permissions": ["read(\"any\")"]
}

Delete document

Delete a document by its unique ID.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- documentId string
  required
  
  Document ID.
Response
- 204 application/json
Rate limits

This endpoint is not limited when using Server SDKs with API keys. If you are using SSR with setSession, these rate limits will still apply. Learn more about SSR rate limits.

The limit is applied for each unique limit key.

Time frame

Attempts

Key

1 minutes 60 requests IP + METHOD + URL + USER ID

Learn more about rate limits

Time frame	Attempts	Key
1 minutes	60 requests	IP + METHOD + URL + USER ID

Endpoint

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

REST

DELETE /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Session: 
X-Appwrite-Key: <YOUR_API_KEY>
X-Appwrite-JWT: <YOUR_JWT>

List indexes

List indexes in the collection.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- 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: key, type, status, attributes, error
Response
- 200 application/json
  
  Indexes List

Endpoint

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

REST

GET /v1/databases/{databaseId}/collections/{collectionId}/indexes HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

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.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Index Key.
- type string
  required
  
  Index type.
- attributes array
  required
  
  Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
- orders array
  
  Array of index orders. Maximum of 100 orders are allowed.
Response
- 202 application/json
  
  Index

Endpoint

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

REST

POST /v1/databases/{databaseId}/collections/{collectionId}/indexes HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "key": ,
  "type": "key",
  "attributes": [],
  "orders": []
}

Get index

Get index by ID.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Index Key.
Response
- 200 application/json
  
  Index

Endpoint

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

REST

GET /v1/databases/{databaseId}/collections/{collectionId}/indexes/{key} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Delete index

Delete an index.

Request
- databaseId string
  required
  
  Database ID.
- collectionId string
  required
  
  Collection ID. You can create a new collection using the Database service server integration.
- key string
  required
  
  Index Key.
Response
- 204 application/json

Endpoint

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

REST

DELETE /v1/databases/{databaseId}/collections/{collectionId}/indexes/{key} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Recommended