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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.list()

puts response.inspect

Create Database

Create a new Database.

Request
- databaseId string
  required
  
  Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. 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.
Response
- 201 application/json
  
  Database

Endpoint

POST /databases

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.create(database_id: '[DATABASE_ID]', name: '[NAME]')

puts response.inspect

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}

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.get(database_id: '[DATABASE_ID]')

puts response.inspect

Update Database

Update a database by its unique ID.

Request
- databaseId string
  required
  
  Database ID.
- name string
  required
  
  Collection name. Max length: 128 chars.
Response
- 200 application/json
  
  Database

Endpoint

PUT /databases/{databaseId}

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.update(database_id: '[DATABASE_ID]', name: '[NAME]')

puts response.inspect

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}

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.delete(database_id: '[DATABASE_ID]')

puts response.inspect

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.list_collections(database_id: '[DATABASE_ID]')

puts response.inspect

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 your own unique ID or pass the string "unique()" to auto generate it. 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.
Response
- 201 application/json
  
  Collection

Endpoint

POST /databases/{databaseId}/collections

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.create_collection(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', name: '[NAME]')

puts response.inspect

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}

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.get_collection(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]')

puts response.inspect

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 permission 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?
Response
- 200 application/json
  
  Collection

Endpoint

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.update_collection(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', name: '[NAME]')

puts response.inspect

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}

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.delete_collection(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]')

puts response.inspect

List Attributes

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

Endpoint

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.list_attributes(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]')

puts response.inspect

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.create_boolean_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false)

puts response.inspect

Create DateTime 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 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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.create_datetime_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false)

puts response.inspect

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.create_email_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false)

puts response.inspect

Create Enum 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 4096 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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.create_enum_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', elements: [], required: false)

puts response.inspect

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.create_float_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false)

puts response.inspect

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.create_integer_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false)

puts response.inspect

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.create_ip_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false)

puts response.inspect

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?
Response
- 202 application/json
  
  AttributeString

Endpoint

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.create_string_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', size: 1, required: false)

puts response.inspect

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.create_url_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false)

puts response.inspect

Get 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
- 200 application/json
  
  AttributeDatetime
  AttributeBoolean
  AttributeInteger
  AttributeFloat
  AttributeEmail
  AttributeEnum
  AttributeURL
  AttributeIP
  AttributeDatetime
  AttributeString

Endpoint

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.get_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '')

puts response.inspect

Delete 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}

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.delete_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '')

puts response.inspect

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. On admin mode, this endpoint will return a list of all of documents belonging to the provided collectionId. Learn more about different API modes.

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.list_documents(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]')

puts response.inspect

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 your own unique ID or pass the string "unique()" to auto generate it. 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 the current user is granted with 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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.create_document(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', document_id: '[DOCUMENT_ID]', data: {})

puts response.inspect

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.
Response
- 200 application/json
  
  Document

Endpoint

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.get_document(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', document_id: '[DOCUMENT_ID]')

puts response.inspect

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}

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.update_document(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', document_id: '[DOCUMENT_ID]')

puts response.inspect

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}

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.delete_document(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', document_id: '[DOCUMENT_ID]')

puts response.inspect

List Indexes

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

Endpoint

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.list_indexes(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]')

puts response.inspect

Create 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.
- 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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.create_index(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', type: 'key', attributes: [])

puts response.inspect

Get 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
- 200 application/json
  
  Index

Endpoint

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

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.get_index(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '')

puts response.inspect

Delete 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}

Ruby

require 'Appwrite'

include Appwrite

client = Client.new
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

databases = Databases.new(client)

response = databases.delete_index(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '')

puts response.inspect

Recommended