Docs

Databases API


Server integration with  

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.

Create Database

POST/v1/databases

Create a new Database.

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "databases.write" scope.

HTTP Request

Name Type Description
databaseId required string

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 required string

Collection name. Max length: 128 chars.

HTTP Response

Status Code Content Type Payload
201  Created application/json Database Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.create('[DATABASE_ID]', '[NAME]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.create('[DATABASE_ID]', '[NAME]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->create('[DATABASE_ID]', '[NAME]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create('[DATABASE_ID]', '[NAME]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    Database result = await databases.Create(
        databaseId: "[DATABASE_ID]",
        name: "[NAME]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.create(
        databaseId: '[DATABASE_ID]',
        name: '[NAME]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.create(
        databaseId = "[DATABASE_ID]",
        name = "[NAME]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.create(
        "[DATABASE_ID]",
        "[NAME]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let database = try await databases.create(
        databaseId: "[DATABASE_ID]",
        name: "[NAME]"
    )
    
    
  • mutation {
        databasesCreate(
            databaseId: "[DATABASE_ID]",
            name: "[NAME]"
        ) {
            _id
            name
            _createdAt
            _updatedAt
        }
    }
    
  • POST /v1/databases HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "databaseId": "[DATABASE_ID]",
      "name": "[NAME]"
    }
    

List Databases

GET/v1/databases

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "databases.read" scope.

HTTP Request

Name Type Description
queries 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 optional string

Search term to filter your list results. Max length: 256 chars.

HTTP Response

Status Code Content Type Payload
200  OK application/json Databases List Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.list();
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.list();
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->list();
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.list()
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    DatabaseList result = await databases.List();
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.list(
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.list(
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.list(
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let databaseList = try await databases.list()
    
    
  • query {
        databasesList {
            total
            databases {
                _id
                name
                _createdAt
                _updatedAt
            }
        }
    }
    
  • GET /v1/databases HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    

Get Database

GET/v1/databases/{databaseId}

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "databases.read" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

HTTP Response

Status Code Content Type Payload
200  OK application/json Database Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.get('[DATABASE_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.get('[DATABASE_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->get('[DATABASE_ID]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.get('[DATABASE_ID]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    Database result = await databases.Get(
        databaseId: "[DATABASE_ID]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.get(
        databaseId: '[DATABASE_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.get(
        databaseId = "[DATABASE_ID]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.get(
        "[DATABASE_ID]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let database = try await databases.get(
        databaseId: "[DATABASE_ID]"
    )
    
    
  • query {
        databasesGet(
            databaseId: "[DATABASE_ID]"
        ) {
            _id
            name
            _createdAt
            _updatedAt
        }
    }
    
  • GET /v1/databases/{databaseId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    

Update Database

PUT/v1/databases/{databaseId}

Update a database by its unique ID.

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "databases.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

name required string

Database name. Max length: 128 chars.

HTTP Response

Status Code Content Type Payload
200  OK application/json Database Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.update('[DATABASE_ID]', '[NAME]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.update('[DATABASE_ID]', '[NAME]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->update('[DATABASE_ID]', '[NAME]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.update('[DATABASE_ID]', '[NAME]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    Database result = await databases.Update(
        databaseId: "[DATABASE_ID]",
        name: "[NAME]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.update(
        databaseId: '[DATABASE_ID]',
        name: '[NAME]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.update(
        databaseId = "[DATABASE_ID]",
        name = "[NAME]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.update(
        "[DATABASE_ID]",
        "[NAME]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let database = try await databases.update(
        databaseId: "[DATABASE_ID]",
        name: "[NAME]"
    )
    
    
  • mutation {
        databasesUpdate(
            databaseId: "[DATABASE_ID]",
            name: "[NAME]"
        ) {
            _id
            name
            _createdAt
            _updatedAt
        }
    }
    
  • PUT /v1/databases/{databaseId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "name": "[NAME]"
    }
    

Delete Database

DELETE/v1/databases/{databaseId}

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "databases.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

HTTP Response

Status Code Content Type Payload
204  No Content - -
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.delete('[DATABASE_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.delete('[DATABASE_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->delete('[DATABASE_ID]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.delete('[DATABASE_ID]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    await databases.Delete(
        databaseId: "[DATABASE_ID]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.delete(
        databaseId: '[DATABASE_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.delete(
        databaseId = "[DATABASE_ID]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.delete(
        "[DATABASE_ID]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let result = try await databases.delete(
        databaseId: "[DATABASE_ID]"
    )
    
    
  • mutation {
        databasesDelete(
            databaseId: "[DATABASE_ID]"
        ) {
            status
        }
    }
    
  • DELETE /v1/databases/{databaseId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    

Create Collection

POST/v1/databases/{databaseId}/collections

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.

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

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 required string

Collection name. Max length: 128 chars.

permissions optional array

An array of permissions strings. By default, no user is granted with any permissions. Learn more about permissions.

documentSecurity optional 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.

HTTP Response

Status Code Content Type Payload
201  Created application/json Collection Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.createCollection('[DATABASE_ID]', '[COLLECTION_ID]', '[NAME]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.createCollection('[DATABASE_ID]', '[COLLECTION_ID]', '[NAME]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->createCollection('[DATABASE_ID]', '[COLLECTION_ID]', '[NAME]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create_collection('[DATABASE_ID]', '[COLLECTION_ID]', '[NAME]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    Collection result = await databases.CreateCollection(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        name: "[NAME]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.createCollection(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        name: '[NAME]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.createCollection(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        name = "[NAME]",
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.createCollection(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "[NAME]",
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let collection = try await databases.createCollection(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        name: "[NAME]"
    )
    
    
  • mutation {
        databasesCreateCollection(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            name: "[NAME]"
        ) {
            _id
            _createdAt
            _updatedAt
            _permissions
            databaseId
            name
            enabled
            documentSecurity
            attributes
            indexes {
                key
                type
                status
                attributes
            }
        }
    }
    
  • POST /v1/databases/{databaseId}/collections HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "collectionId": "[COLLECTION_ID]",
      "name": "[NAME]",
      "permissions": ["read(\"any\")"],
      "documentSecurity": false
    }
    

List Collections

GET/v1/databases/{databaseId}/collections

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.read" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

queries 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 optional string

Search term to filter your list results. Max length: 256 chars.

HTTP Response

Status Code Content Type Payload
200  OK application/json Collections List Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.listCollections('[DATABASE_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.listCollections('[DATABASE_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->listCollections('[DATABASE_ID]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.list_collections('[DATABASE_ID]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    CollectionList result = await databases.ListCollections(
        databaseId: "[DATABASE_ID]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.listCollections(
        databaseId: '[DATABASE_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.listCollections(
        databaseId = "[DATABASE_ID]",
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.listCollections(
        "[DATABASE_ID]",
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let collectionList = try await databases.listCollections(
        databaseId: "[DATABASE_ID]"
    )
    
    
  • query {
        databasesListCollections(
            databaseId: "[DATABASE_ID]"
        ) {
            total
            collections {
                _id
                _createdAt
                _updatedAt
                _permissions
                databaseId
                name
                enabled
                documentSecurity
                attributes
                indexes {
                    key
                    type
                    status
                    attributes
                }
            }
        }
    }
    
  • GET /v1/databases/{databaseId}/collections HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    

Get Collection

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.read" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID.

HTTP Response

Status Code Content Type Payload
200  OK application/json Collection Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.getCollection('[DATABASE_ID]', '[COLLECTION_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.getCollection('[DATABASE_ID]', '[COLLECTION_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->getCollection('[DATABASE_ID]', '[COLLECTION_ID]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.get_collection('[DATABASE_ID]', '[COLLECTION_ID]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    Collection result = await databases.GetCollection(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.getCollection(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.getCollection(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.getCollection(
        "[DATABASE_ID]",
        "[COLLECTION_ID]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let collection = try await databases.getCollection(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]"
    )
    
    
  • query {
        databasesGetCollection(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]"
        ) {
            _id
            _createdAt
            _updatedAt
            _permissions
            databaseId
            name
            enabled
            documentSecurity
            attributes
            indexes {
                key
                type
                status
                attributes
            }
        }
    }
    
  • GET /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    

Update Collection

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

Update a collection by its unique ID.

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID.

name required string

Collection name. Max length: 128 chars.

permissions optional array

An array of permission strings. By default, the current permissions are inherited. Learn more about permissions.

documentSecurity optional 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 optional boolean

Is collection enabled?

HTTP Response

Status Code Content Type Payload
200  OK application/json Collection Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.updateCollection('[DATABASE_ID]', '[COLLECTION_ID]', '[NAME]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.updateCollection('[DATABASE_ID]', '[COLLECTION_ID]', '[NAME]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->updateCollection('[DATABASE_ID]', '[COLLECTION_ID]', '[NAME]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.update_collection('[DATABASE_ID]', '[COLLECTION_ID]', '[NAME]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    Collection result = await databases.UpdateCollection(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        name: "[NAME]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.updateCollection(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        name: '[NAME]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.updateCollection(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        name = "[NAME]",
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.updateCollection(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "[NAME]",
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let collection = try await databases.updateCollection(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        name: "[NAME]"
    )
    
    
  • mutation {
        databasesUpdateCollection(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            name: "[NAME]"
        ) {
            _id
            _createdAt
            _updatedAt
            _permissions
            databaseId
            name
            enabled
            documentSecurity
            attributes
            indexes {
                key
                type
                status
                attributes
            }
        }
    }
    
  • PUT /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "name": "[NAME]",
      "permissions": ["read(\"any\")"],
      "documentSecurity": false,
      "enabled": false
    }
    

Delete Collection

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID.

HTTP Response

Status Code Content Type Payload
204  No Content - -
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.deleteCollection('[DATABASE_ID]', '[COLLECTION_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.deleteCollection('[DATABASE_ID]', '[COLLECTION_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->deleteCollection('[DATABASE_ID]', '[COLLECTION_ID]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.delete_collection('[DATABASE_ID]', '[COLLECTION_ID]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    await databases.DeleteCollection(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.deleteCollection(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.deleteCollection(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.deleteCollection(
        "[DATABASE_ID]",
        "[COLLECTION_ID]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let result = try await databases.deleteCollection(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]"
    )
    
    
  • mutation {
        databasesDeleteCollection(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]"
        ) {
            status
        }
    }
    
  • DELETE /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    

Create String Attribute

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

Create a string attribute.

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

size required integer

Attribute size for text attributes, in number of characters.

required required boolean

Is attribute required?

default optional string

Default value for attribute when not provided. Cannot be set when attribute is required.

array optional boolean

Is attribute an array?

HTTP Response

Status Code Content Type Payload
202   application/json AttributeString Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.createStringAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', 1, false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.createStringAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', 1, false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->createStringAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', 1, false);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create_string_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', 1, False)
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeString result = await databases.CreateStringAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        size: 1,
        required: false);
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.createStringAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        size: 1,
        xrequired: false,
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.createStringAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        size = 1,
        required = false,
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.createStringAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        1,
        false,
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeString = try await databases.createStringAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        size: 1,
        required: xfalse
    )
    
    
  • mutation {
        databasesCreateStringAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            size: 1,
            required: false
        ) {
            key
            type
            status
            required
            size
        }
    }
    
  • POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/string HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "key": ,
      "size": 1,
      "required": false,
      "default": "[DEFAULT]",
      "array": false
    }
    

Create Email Attribute

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

Create an email attribute.

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

default optional string

Default value for attribute when not provided. Cannot be set when attribute is required.

array optional boolean

Is attribute an array?

HTTP Response

Status Code Content Type Payload
202   application/json AttributeEmail Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.createEmailAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.createEmailAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->createEmailAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create_email_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False)
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeEmail result = await databases.CreateEmailAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false);
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.createEmailAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.createEmailAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.createEmailAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeEmail = try await databases.createEmailAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse
    )
    
    
  • mutation {
        databasesCreateEmailAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false
        ) {
            key
            type
            status
            required
            format
        }
    }
    
  • POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/email HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "key": ,
      "required": false,
      "default": "email@example.com",
      "array": false
    }
    

Create Enum Attribute

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

elements required array

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 required boolean

Is attribute required?

default optional string

Default value for attribute when not provided. Cannot be set when attribute is required.

array optional boolean

Is attribute an array?

HTTP Response

Status Code Content Type Payload
202   application/json AttributeEnum Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.createEnumAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', [], false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.createEnumAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', [], false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->createEnumAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', [], false);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create_enum_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', [], False)
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeEnum result = await databases.CreateEnumAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        elements: new List<string> {},
        required: false);
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.createEnumAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        elements: [],
        xrequired: false,
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.createEnumAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        elements = listOf(),
        required = false,
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.createEnumAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        listOf(),
        false,
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeEnum = try await databases.createEnumAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        elements: [],
        required: xfalse
    )
    
    
  • mutation {
        databasesCreateEnumAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            elements: [],
            required: false
        ) {
            key
            type
            status
            required
            elements
            format
        }
    }
    
  • POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/enum HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "key": ,
      "elements": [],
      "required": false,
      "default": "[DEFAULT]",
      "array": false
    }
    

Create IP Address Attribute

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

Create IP address attribute.

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

default optional string

Default value for attribute when not provided. Cannot be set when attribute is required.

array optional boolean

Is attribute an array?

HTTP Response

Status Code Content Type Payload
202   application/json AttributeIP Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.createIpAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.createIpAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->createIpAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create_ip_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False)
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeIp result = await databases.CreateIpAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false);
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.createIpAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.createIpAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.createIpAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeIp = try await databases.createIpAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse
    )
    
    
  • mutation {
        databasesCreateIpAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false
        ) {
            key
            type
            status
            required
            format
        }
    }
    
  • POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/ip HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "key": ,
      "required": false,
      "default": ,
      "array": false
    }
    

Create URL Attribute

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

Create a URL attribute.

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

default optional string

Default value for attribute when not provided. Cannot be set when attribute is required.

array optional boolean

Is attribute an array?

HTTP Response

Status Code Content Type Payload
202   application/json AttributeURL Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.createUrlAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.createUrlAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->createUrlAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create_url_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False)
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeUrl result = await databases.CreateUrlAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false);
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.createUrlAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.createUrlAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.createUrlAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeUrl = try await databases.createUrlAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse
    )
    
    
  • mutation {
        databasesCreateUrlAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false
        ) {
            key
            type
            status
            required
            format
        }
    }
    
  • POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/url HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "key": ,
      "required": false,
      "default": "https://example.com",
      "array": false
    }
    

Create Integer Attribute

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

min optional integer

Minimum value to enforce on new documents

max optional integer

Maximum value to enforce on new documents

default optional integer

Default value for attribute when not provided. Cannot be set when attribute is required.

array optional boolean

Is attribute an array?

HTTP Response

Status Code Content Type Payload
202   application/json AttributeInteger Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.createIntegerAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.createIntegerAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->createIntegerAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create_integer_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False)
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeInteger result = await databases.CreateIntegerAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false);
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.createIntegerAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.createIntegerAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.createIntegerAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeInteger = try await databases.createIntegerAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse
    )
    
    
  • mutation {
        databasesCreateIntegerAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false
        ) {
            key
            type
            status
            required
        }
    }
    
  • POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/integer HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "key": ,
      "required": false,
      "min": 0,
      "max": 0,
      "default": 0,
      "array": false
    }
    

Create Float Attribute

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

min optional number

Minimum value to enforce on new documents

max optional number

Maximum value to enforce on new documents

default optional number

Default value for attribute when not provided. Cannot be set when attribute is required.

array optional boolean

Is attribute an array?

HTTP Response

Status Code Content Type Payload
202   application/json AttributeFloat Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.createFloatAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.createFloatAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->createFloatAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create_float_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False)
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeFloat result = await databases.CreateFloatAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false);
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.createFloatAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.createFloatAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.createFloatAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeFloat = try await databases.createFloatAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse
    )
    
    
  • mutation {
        databasesCreateFloatAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false
        ) {
            key
            type
            status
            required
        }
    }
    
  • POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/float HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "key": ,
      "required": false,
      "min": 0,
      "max": 0,
      "default": 0,
      "array": false
    }
    

Create Boolean Attribute

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

Create a boolean attribute.

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

default optional boolean

Default value for attribute when not provided. Cannot be set when attribute is required.

array optional boolean

Is attribute an array?

HTTP Response

Status Code Content Type Payload
202   application/json AttributeBoolean Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.createBooleanAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.createBooleanAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->createBooleanAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create_boolean_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False)
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeBoolean result = await databases.CreateBooleanAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false);
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.createBooleanAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.createBooleanAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.createBooleanAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeBoolean = try await databases.createBooleanAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse
    )
    
    
  • mutation {
        databasesCreateBooleanAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false
        ) {
            key
            type
            status
            required
        }
    }
    
  • POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/boolean HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "key": ,
      "required": false,
      "default": false,
      "array": false
    }
    

Create DateTime Attribute

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

default optional string

Default value for the attribute in ISO 8601 format. Cannot be set when attribute is required.

array optional boolean

Is attribute an array?

HTTP Response

Status Code Content Type Payload
202   application/json AttributeDatetime Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.createDatetimeAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.createDatetimeAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->createDatetimeAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create_datetime_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False)
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeDatetime result = await databases.CreateDatetimeAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false);
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.createDatetimeAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.createDatetimeAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.createDatetimeAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeDatetime = try await databases.createDatetimeAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse
    )
    
    
  • mutation {
        databasesCreateDatetimeAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false
        ) {
            key
            type
            status
            required
            format
        }
    }
    
  • POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/datetime HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "key": ,
      "required": false,
      "default": ,
      "array": false
    }
    

Create Relationship Attribute

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

Create relationship attribute. Learn more about relationship attributes.

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

relatedCollectionId required string

Related Collection ID. You can create a new collection using the Database service server integration.

type required string

Relation type

twoWay optional boolean

Is Two Way?

key optional string

Attribute Key.

twoWayKey optional string

Two Way Attribute Key.

onDelete optional string

Constraints option

HTTP Response

Status Code Content Type Payload
202   application/json AttributeRelationship Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.createRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '[RELATED_COLLECTION_ID]', 'oneToOne');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.createRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '[RELATED_COLLECTION_ID]', 'oneToOne');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->createRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '[RELATED_COLLECTION_ID]', 'oneToOne');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create_relationship_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '[RELATED_COLLECTION_ID]', 'oneToOne')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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_relationship_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', related_collection_id: '[RELATED_COLLECTION_ID]', type: 'oneToOne')
    
    puts response.inspect
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeRelationship result = await databases.CreateRelationshipAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        relatedCollectionId: "[RELATED_COLLECTION_ID]",
        type: "oneToOne");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.createRelationshipAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        relatedCollectionId: '[RELATED_COLLECTION_ID]',
        type: 'oneToOne',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.createRelationshipAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        relatedCollectionId = "[RELATED_COLLECTION_ID]",
        type = "oneToOne",
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.createRelationshipAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "[RELATED_COLLECTION_ID]",
        "oneToOne",
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeRelationship = try await databases.createRelationshipAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        relatedCollectionId: "[RELATED_COLLECTION_ID]",
        type: "oneToOne"
    )
    
    
  • mutation {
        databasesCreateRelationshipAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            relatedCollectionId: "[RELATED_COLLECTION_ID]",
            type: "oneToOne"
        ) {
            key
            type
            status
            required
            relatedCollection
            relationType
            twoWay
            twoWayKey
            onDelete
            side
        }
    }
    
  • POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/relationship HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "relatedCollectionId": "[RELATED_COLLECTION_ID]",
      "type": "oneToOne",
      "twoWay": false,
      "key": ,
      "twoWayKey": ,
      "onDelete": "cascade"
    }
    

List Attributes

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.read" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

HTTP Response

Status Code Content Type Payload
200  OK application/json Attributes List Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.listAttributes('[DATABASE_ID]', '[COLLECTION_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.listAttributes('[DATABASE_ID]', '[COLLECTION_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->listAttributes('[DATABASE_ID]', '[COLLECTION_ID]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.list_attributes('[DATABASE_ID]', '[COLLECTION_ID]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeList result = await databases.ListAttributes(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.listAttributes(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.listAttributes(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.listAttributes(
        "[DATABASE_ID]",
        "[COLLECTION_ID]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeList = try await databases.listAttributes(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]"
    )
    
    
  • query {
        databasesListAttributes(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]"
        ) {
            total
            attributes
        }
    }
    
  • GET /v1/databases/{databaseId}/collections/{collectionId}/attributes HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    

Get Attribute

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.read" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

HTTP Response

Status Code Content Type Payload
200  OK application/json attributeBoolean
attributeInteger
attributeFloat
attributeEmail
attributeEnum
attributeUrl
attributeIp
attributeDatetime
attributeRelationship
attributeString
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.getAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.getAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->getAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.get_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
     result = await databases.GetAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.getAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.getAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = ""
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.getAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        ""
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let result = try await databases.getAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: ""
    )
    
    
  • query {
        databasesGetAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: ""
        ) {
            status
        }
    }
    
  • GET /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    

Update String Attribute

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

default required string

Default value for attribute when not provided. Cannot be set when attribute is required.

HTTP Response

Status Code Content Type Payload
200  OK - AttributeString Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.updateStringAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, '[DEFAULT]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.updateStringAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, '[DEFAULT]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->updateStringAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, '[DEFAULT]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.update_string_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, '[DEFAULT]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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_string_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false, default: '[DEFAULT]')
    
    puts response.inspect
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeString result = await databases.UpdateStringAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false,
        default: "[DEFAULT]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.updateStringAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
        xdefault: '[DEFAULT]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.updateStringAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
        default = "[DEFAULT]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.updateStringAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        "[DEFAULT]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeString = try await databases.updateStringAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse,
        default: "[DEFAULT]"
    )
    
    
  • mutation {
        databasesUpdateStringAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false,
            default: "[DEFAULT]"
        ) {
            key
            type
            status
            required
            size
        }
    }
    
  • PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/string/{key} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "required": false,
      "default": "[DEFAULT]"
    }
    

Update Email Attribute

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

default required string

Default value for attribute when not provided. Cannot be set when attribute is required.

HTTP Response

Status Code Content Type Payload
200  OK - AttributeEmail Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.updateEmailAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, 'email@example.com');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.updateEmailAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, 'email@example.com');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->updateEmailAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, 'email@example.com');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.update_email_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, 'email@example.com')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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_email_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false, default: 'email@example.com')
    
    puts response.inspect
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeEmail result = await databases.UpdateEmailAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false,
        default: "email@example.com");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.updateEmailAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
        xdefault: 'email@example.com',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.updateEmailAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
        default = "email@example.com"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.updateEmailAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        "email@example.com"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeEmail = try await databases.updateEmailAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse,
        default: "email@example.com"
    )
    
    
  • mutation {
        databasesUpdateEmailAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false,
            default: "email@example.com"
        ) {
            key
            type
            status
            required
            format
        }
    }
    
  • PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/email/{key} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "required": false,
      "default": "email@example.com"
    }
    

Update Enum Attribute

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

elements required array

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 required boolean

Is attribute required?

default required string

Default value for attribute when not provided. Cannot be set when attribute is required.

HTTP Response

Status Code Content Type Payload
200  OK - AttributeEnum Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.updateEnumAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', [], false, '[DEFAULT]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.updateEnumAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', [], false, '[DEFAULT]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->updateEnumAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', [], false, '[DEFAULT]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.update_enum_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', [], False, '[DEFAULT]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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_enum_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', elements: [], required: false, default: '[DEFAULT]')
    
    puts response.inspect
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeEnum result = await databases.UpdateEnumAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        elements: new List<string> {},
        required: false,
        default: "[DEFAULT]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.updateEnumAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        elements: [],
        xrequired: false,
        xdefault: '[DEFAULT]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.updateEnumAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        elements = listOf(),
        required = false,
        default = "[DEFAULT]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.updateEnumAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        listOf(),
        false,
        "[DEFAULT]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeEnum = try await databases.updateEnumAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        elements: [],
        required: xfalse,
        default: "[DEFAULT]"
    )
    
    
  • mutation {
        databasesUpdateEnumAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            elements: [],
            required: false,
            default: "[DEFAULT]"
        ) {
            key
            type
            status
            required
            elements
            format
        }
    }
    
  • PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "elements": [],
      "required": false,
      "default": "[DEFAULT]"
    }
    

Update IP Address Attribute

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

default required string

Default value for attribute when not provided. Cannot be set when attribute is required.

HTTP Response

Status Code Content Type Payload
200  OK - AttributeIP Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.updateIpAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.updateIpAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->updateIpAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, '');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.update_ip_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, '')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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_ip_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false, default: '')
    
    puts response.inspect
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeIp result = await databases.UpdateIpAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false,
        default: "");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.updateIpAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
        xdefault: '',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.updateIpAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
        default = ""
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.updateIpAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        ""
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeIp = try await databases.updateIpAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse,
        default: ""
    )
    
    
  • mutation {
        databasesUpdateIpAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false,
            default: ""
        ) {
            key
            type
            status
            required
            format
        }
    }
    
  • PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "required": false,
      "default": 
    }
    

Update URL Attribute

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

default required string

Default value for attribute when not provided. Cannot be set when attribute is required.

HTTP Response

Status Code Content Type Payload
200  OK - AttributeURL Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.updateUrlAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, 'https://example.com');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.updateUrlAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, 'https://example.com');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->updateUrlAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, 'https://example.com');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.update_url_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, 'https://example.com')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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_url_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false, default: 'https://example.com')
    
    puts response.inspect
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeUrl result = await databases.UpdateUrlAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false,
        default: "https://example.com");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.updateUrlAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
        xdefault: 'https://example.com',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.updateUrlAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
        default = "https://example.com"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.updateUrlAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        "https://example.com"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeUrl = try await databases.updateUrlAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse,
        default: "https://example.com"
    )
    
    
  • mutation {
        databasesUpdateUrlAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false,
            default: "https://example.com"
        ) {
            key
            type
            status
            required
            format
        }
    }
    
  • PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/url/{key} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "required": false,
      "default": "https://example.com"
    }
    

Update Integer Attribute

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

min required integer

Minimum value to enforce on new documents

max required integer

Maximum value to enforce on new documents

default required integer

Default value for attribute when not provided. Cannot be set when attribute is required.

HTTP Response

Status Code Content Type Payload
200  OK - AttributeInteger Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.updateIntegerAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, null, null, null);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.updateIntegerAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, null, null, null);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->updateIntegerAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, null, null, null);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.update_integer_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, None, None, None)
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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_integer_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false, min: null, max: null, default: null)
    
    puts response.inspect
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeInteger result = await databases.UpdateIntegerAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false,
        min: 0,
        max: 0,
        default: 0);
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.updateIntegerAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
        min: 0,
        max: 0,
        xdefault: 0,
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.updateIntegerAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
        min = 0,
        max = 0,
        default = 0
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.updateIntegerAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        0,
        0,
        0
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeInteger = try await databases.updateIntegerAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse,
        min: 0,
        max: 0,
        default: 0
    )
    
    
  • mutation {
        databasesUpdateIntegerAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false,
            min: 0,
            max: 0,
            default: 0
        ) {
            key
            type
            status
            required
        }
    }
    
  • PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "required": false,
      "min": 0,
      "max": 0,
      "default": 0
    }
    

Update Float Attribute

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

min required number

Minimum value to enforce on new documents

max required number

Maximum value to enforce on new documents

default required number

Default value for attribute when not provided. Cannot be set when attribute is required.

HTTP Response

Status Code Content Type Payload
200  OK - AttributeFloat Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.updateFloatAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, null, null, null);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.updateFloatAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, null, null, null);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->updateFloatAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, null, null, null);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.update_float_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, None, None, None)
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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_float_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false, min: null, max: null, default: null)
    
    puts response.inspect
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeFloat result = await databases.UpdateFloatAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false,
        min: 0,
        max: 0,
        default: 0);
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.updateFloatAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
        min: 0,
        max: 0,
        xdefault: 0,
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.updateFloatAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
        min = 0,
        max = 0,
        default = 0
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.updateFloatAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        0,
        0,
        0
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeFloat = try await databases.updateFloatAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse,
        min: 0,
        max: 0,
        default: 0
    )
    
    
  • mutation {
        databasesUpdateFloatAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false,
            min: 0,
            max: 0,
            default: 0
        ) {
            key
            type
            status
            required
        }
    }
    
  • PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/float/{key} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "required": false,
      "min": 0,
      "max": 0,
      "default": 0
    }
    

Update Boolean Attribute

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

default required boolean

Default value for attribute when not provided. Cannot be set when attribute is required.

HTTP Response

Status Code Content Type Payload
200  OK - AttributeBoolean Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.updateBooleanAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.updateBooleanAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, false);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->updateBooleanAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, false);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.update_boolean_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, False)
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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_boolean_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false, default: false)
    
    puts response.inspect
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeBoolean result = await databases.UpdateBooleanAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false,
        default: false);
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.updateBooleanAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
        xdefault: false,
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.updateBooleanAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
        default = false
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.updateBooleanAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        false
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeBoolean = try await databases.updateBooleanAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse,
        default: xfalse
    )
    
    
  • mutation {
        databasesUpdateBooleanAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false,
            default: false
        ) {
            key
            type
            status
            required
        }
    }
    
  • PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "required": false,
      "default": false
    }
    

Update DateTime Attribute

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

required required boolean

Is attribute required?

default required string

Default value for attribute when not provided. Cannot be set when attribute is required.

HTTP Response

Status Code Content Type Payload
200  OK - AttributeDatetime Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.updateDatetimeAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.updateDatetimeAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->updateDatetimeAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, '');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.update_datetime_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, '')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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_datetime_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '', required: false, default: '')
    
    puts response.inspect
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeDatetime result = await databases.UpdateDatetimeAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false,
        default: "");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.updateDatetimeAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        xrequired: false,
        xdefault: '',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.updateDatetimeAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        required = false,
        default = ""
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.updateDatetimeAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        false,
        ""
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeDatetime = try await databases.updateDatetimeAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: xfalse,
        default: ""
    )
    
    
  • mutation {
        databasesUpdateDatetimeAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            required: false,
            default: ""
        ) {
            key
            type
            status
            required
            format
        }
    }
    
  • PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "required": false,
      "default": 
    }
    

Update Relationship Attribute

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

Update relationship attribute. Learn more about relationship attributes.

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

onDelete optional string

Constraints option

HTTP Response

Status Code Content Type Payload
200  OK - AttributeRelationship Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.updateRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.updateRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->updateRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.update_relationship_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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_relationship_attribute(database_id: '[DATABASE_ID]', collection_id: '[COLLECTION_ID]', key: '')
    
    puts response.inspect
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    AttributeRelationship result = await databases.UpdateRelationshipAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.updateRelationshipAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.updateRelationshipAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.updateRelationshipAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let attributeRelationship = try await databases.updateRelationshipAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: ""
    )
    
    
  • mutation {
        databasesUpdateRelationshipAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: ""
        ) {
            key
            type
            status
            required
            relatedCollection
            relationType
            twoWay
            twoWayKey
            onDelete
            side
        }
    }
    
  • PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "onDelete": "cascade"
    }
    

Delete Attribute

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Attribute Key.

HTTP Response

Status Code Content Type Payload
204  No Content - -
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.deleteAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.deleteAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->deleteAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.delete_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    await databases.DeleteAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.deleteAttribute(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.deleteAttribute(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = ""
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.deleteAttribute(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        ""
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let result = try await databases.deleteAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: ""
    )
    
    
  • mutation {
        databasesDeleteAttribute(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: ""
        ) {
            status
        }
    }
    
  • DELETE /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    

Create Index

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Index Key.

type required string

Index type.

attributes required array

Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.

orders optional array

Array of index orders. Maximum of 100 orders are allowed.

HTTP Response

Status Code Content Type Payload
202   application/json Index Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.createIndex('[DATABASE_ID]', '[COLLECTION_ID]', '', 'key', []);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.createIndex('[DATABASE_ID]', '[COLLECTION_ID]', '', 'key', []);
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->createIndex('[DATABASE_ID]', '[COLLECTION_ID]', '', 'key', []);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create_index('[DATABASE_ID]', '[COLLECTION_ID]', '', 'key', [])
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    Index result = await databases.CreateIndex(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        type: "key",
        attributes: new List<string> {});
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.createIndex(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
        type: 'key',
        attributes: [],
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.createIndex(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = "",
        type = "key",
        attributes = listOf(),
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.createIndex(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "",
        "key",
        listOf(),
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let index = try await databases.createIndex(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        type: "key",
        attributes: []
    )
    
    
  • mutation {
        databasesCreateIndex(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: "",
            type: "key",
            attributes: []
        ) {
            key
            type
            status
            attributes
        }
    }
    
  • POST /v1/databases/{databaseId}/collections/{collectionId}/indexes HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    {
      "key": ,
      "type": "key",
      "attributes": [],
      "orders": []
    }
    

List Indexes

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.read" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

HTTP Response

Status Code Content Type Payload
200  OK application/json Indexes List Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.listIndexes('[DATABASE_ID]', '[COLLECTION_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.listIndexes('[DATABASE_ID]', '[COLLECTION_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->listIndexes('[DATABASE_ID]', '[COLLECTION_ID]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.list_indexes('[DATABASE_ID]', '[COLLECTION_ID]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    IndexList result = await databases.ListIndexes(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.listIndexes(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.listIndexes(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.listIndexes(
        "[DATABASE_ID]",
        "[COLLECTION_ID]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let indexList = try await databases.listIndexes(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]"
    )
    
    
  • query {
        databasesListIndexes(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]"
        ) {
            total
            indexes {
                key
                type
                status
                attributes
            }
        }
    }
    
  • GET /v1/databases/{databaseId}/collections/{collectionId}/indexes HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    

Get Index

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.read" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Index Key.

HTTP Response

Status Code Content Type Payload
200  OK application/json Index Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.getIndex('[DATABASE_ID]', '[COLLECTION_ID]', '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.getIndex('[DATABASE_ID]', '[COLLECTION_ID]', '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->getIndex('[DATABASE_ID]', '[COLLECTION_ID]', '');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.get_index('[DATABASE_ID]', '[COLLECTION_ID]', '')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    Index result = await databases.GetIndex(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.getIndex(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.getIndex(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = ""
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.getIndex(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        ""
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let index = try await databases.getIndex(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: ""
    )
    
    
  • query {
        databasesGetIndex(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: ""
        ) {
            key
            type
            status
            attributes
        }
    }
    
  • GET /v1/databases/{databaseId}/collections/{collectionId}/indexes/{key} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    

Delete Index

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is create with the "collections.write" scope.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

key required string

Index Key.

HTTP Response

Status Code Content Type Payload
204  No Content - -
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.deleteIndex('[DATABASE_ID]', '[COLLECTION_ID]', '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.deleteIndex('[DATABASE_ID]', '[COLLECTION_ID]', '');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->deleteIndex('[DATABASE_ID]', '[COLLECTION_ID]', '');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.delete_index('[DATABASE_ID]', '[COLLECTION_ID]', '')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    await databases.DeleteIndex(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.deleteIndex(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        key: '',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.deleteIndex(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        key = ""
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.deleteIndex(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        ""
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let result = try await databases.deleteIndex(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: ""
    )
    
    
  • mutation {
        databasesDeleteIndex(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            key: ""
        ) {
            status
        }
    }
    
  • DELETE /v1/databases/{databaseId}/collections/{collectionId}/indexes/{key} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    
    

Create Document

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

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.

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is created with the "documents.write" scope. You can also authenticate using a valid JWT and perform actions on behalf of your user.

Rate Limits

This endpoint is limited to 120 requests in every 1 minutes per IP address, method and user account. We use rate limits to avoid service abuse by users and as a security practice. Learn more about rate limiting.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration. Make sure to define attributes before creating documents.

documentId required string

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 required object

Document data as JSON object.

permissions optional array

An array of permissions strings. By default, only the current user is granted all permissions. Learn more about permissions.

HTTP Response

Status Code Content Type Payload
201  Created application/json Document Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.createDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]', {});
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.createDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]', {});
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->createDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]', []);
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.create_document('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]', {})
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    Document result = await databases.CreateDocument(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        documentId: "[DOCUMENT_ID]",
        data: [object]);
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.createDocument(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        documentId: '[DOCUMENT_ID]',
        data: {},
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.createDocument(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        documentId = "[DOCUMENT_ID]",
        data = mapOf( "a" to "b" ),
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.createDocument(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "[DOCUMENT_ID]",
        mapOf( "a" to "b" ),
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let document = try await databases.createDocument(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        documentId: "[DOCUMENT_ID]",
        data: [:]
    )
    
    
  • mutation {
        databasesCreateDocument(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            documentId: "[DOCUMENT_ID]",
            data: "{}"
        ) {
            _id
            _collectionId
            _databaseId
            _createdAt
            _updatedAt
            _permissions
            data
        }
    }
    
  • POST /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    {
      "documentId": "[DOCUMENT_ID]",
      "data": {},
      "permissions": ["read(\"any\")"]
    }
    

List Documents

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is created with the "documents.read" scope. You can also authenticate using a valid JWT and perform actions on behalf of your user.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

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

HTTP Response

Status Code Content Type Payload
200  OK application/json Documents List Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.listDocuments('[DATABASE_ID]', '[COLLECTION_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.listDocuments('[DATABASE_ID]', '[COLLECTION_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->listDocuments('[DATABASE_ID]', '[COLLECTION_ID]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.list_documents('[DATABASE_ID]', '[COLLECTION_ID]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    DocumentList result = await databases.ListDocuments(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.listDocuments(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.listDocuments(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.listDocuments(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let documentList = try await databases.listDocuments(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]"
    )
    
    
  • query {
        databasesListDocuments(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]"
        ) {
            total
            documents {
                _id
                _collectionId
                _databaseId
                _createdAt
                _updatedAt
                _permissions
                data
            }
        }
    }
    
  • GET /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    

Get Document

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is created with the "documents.read" scope. You can also authenticate using a valid JWT and perform actions on behalf of your user.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

documentId required string

Document ID.

queries optional array

Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Only method allowed is select.

HTTP Response

Status Code Content Type Payload
200  OK application/json Document Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.getDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.getDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->getDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.get_document('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    Document result = await databases.GetDocument(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        documentId: "[DOCUMENT_ID]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.getDocument(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        documentId: '[DOCUMENT_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.getDocument(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        documentId = "[DOCUMENT_ID]",
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.getDocument(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "[DOCUMENT_ID]",
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let document = try await databases.getDocument(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        documentId: "[DOCUMENT_ID]"
    )
    
    
  • query {
        databasesGetDocument(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            documentId: "[DOCUMENT_ID]"
        ) {
            _id
            _collectionId
            _databaseId
            _createdAt
            _updatedAt
            _permissions
            data
        }
    }
    
  • GET /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    

Update Document

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

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

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is created with the "documents.write" scope. You can also authenticate using a valid JWT and perform actions on behalf of your user.

Rate Limits

This endpoint is limited to 120 requests in every 1 minutes per IP address, method and user account. We use rate limits to avoid service abuse by users and as a security practice. Learn more about rate limiting.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID.

documentId required string

Document ID.

data optional object

Document data as JSON object. Include only attribute and value pairs to be updated.

permissions optional array

An array of permissions strings. By default, the current permissions are inherited. Learn more about permissions.

HTTP Response

Status Code Content Type Payload
200  OK application/json Document Object
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.updateDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.updateDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->updateDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.update_document('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    Document result = await databases.UpdateDocument(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        documentId: "[DOCUMENT_ID]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.updateDocument(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        documentId: '[DOCUMENT_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.updateDocument(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        documentId = "[DOCUMENT_ID]",
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.updateDocument(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "[DOCUMENT_ID]",
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let document = try await databases.updateDocument(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        documentId: "[DOCUMENT_ID]"
    )
    
    
  • mutation {
        databasesUpdateDocument(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            documentId: "[DOCUMENT_ID]"
        ) {
            _id
            _collectionId
            _databaseId
            _createdAt
            _updatedAt
            _permissions
            data
        }
    }
    
  • PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    {
      "data": {},
      "permissions": ["read(\"any\")"]
    }
    

Delete Document

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

Delete a document by its unique ID.

Authentication

To access this route, init your SDK with your project unique ID and an API Key. Make sure your API Key is created with the "documents.write" scope. You can also authenticate using a valid JWT and perform actions on behalf of your user.

Rate Limits

This endpoint is limited to 60 requests in every 1 minutes per IP address, method and user account. We use rate limits to avoid service abuse by users and as a security practice. Learn more about rate limiting.

HTTP Request

Name Type Description
databaseId required string

Database ID.

collectionId required string

Collection ID. You can create a new collection using the Database service server integration.

documentId required string

Document ID.

HTTP Response

Status Code Content Type Payload
204  No Content - -
Example Request
  • const sdk = require('node-appwrite');
    
    // Init SDK
    const client = new sdk.Client();
    
    const databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    const promise = databases.deleteDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • import * as sdk from "https://deno.land/x/appwrite/mod.ts";
    
    // Init SDK
    let client = new sdk.Client();
    
    let databases = new sdk.Databases(client);
    
    client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    
    let promise = databases.deleteDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]');
    
    promise.then(function (response) {
        console.log(response);
    }, function (error) {
        console.log(error);
    });
  • <?php
    
    use Appwrite\Client;
    use Appwrite\Services\Databases;
    
    $client = new Client();
    
    $client
        ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        ->setProject('5df5acd0d48c2') // Your project ID
        ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
    ;
    
    $databases = new Databases($client);
    
    $result = $databases->deleteDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]');
  • from appwrite.client import Client
    from appwrite.services.databases import Databases
    
    client = Client()
    
    (client
      .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
      .set_project('5df5acd0d48c2') # Your project ID
      .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
    )
    
    databases = Databases(client)
    
    result = databases.delete_document('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]')
    
  • require 'Appwrite'
    
    include Appwrite
    
    client = Client.new
        .set_endpoint('https://cloud.appwrite.io/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
  • using Appwrite;
    using Appwrite.Models;
    
    var client = new Client()
        .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .SetProject("5df5acd0d48c2") // Your project ID
        .SetKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    var databases = new Databases(client);
    
    await databases.DeleteDocument(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        documentId: "[DOCUMENT_ID]");
  • import 'package:dart_appwrite/dart_appwrite.dart';
    
    void main() { // Init SDK
      Client client = Client();
      Databases databases = Databases(client);
    
      client
        .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
        .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
      ;
    
      Future result = databases.deleteDocument(
        databaseId: '[DATABASE_ID]',
        collectionId: '[COLLECTION_ID]',
        documentId: '[DOCUMENT_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
  • import io.appwrite.Client
    import io.appwrite.services.Databases
    
    val client = Client(context)
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    val databases = Databases(client)
    
    val response = databases.deleteDocument(
        databaseId = "[DATABASE_ID]",
        collectionId = "[COLLECTION_ID]",
        documentId = "[DOCUMENT_ID]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Databases;
    
    Client client = new Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2"); // Your secret API key
    
    Databases databases = new Databases(client);
    
    databases.deleteDocument(
        "[DATABASE_ID]",
        "[COLLECTION_ID]",
        "[DOCUMENT_ID]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            System.out.println(result);
        })
    );
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
        .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    
    let databases = Databases(client)
    
    let result = try await databases.deleteDocument(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        documentId: "[DOCUMENT_ID]"
    )
    
    
  • mutation {
        databasesDeleteDocument(
            databaseId: "[DATABASE_ID]",
            collectionId: "[COLLECTION_ID]",
            documentId: "[DOCUMENT_ID]"
        ) {
            status
        }
    }
    
  • DELETE /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-Key: 919c2d18fb5d4...a2ae413da83346ad2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...