Skip to content
post

Create database

Endpoint

posthttps://<REGION>.cloud.appwrite.io/v1/databases

Description

Create a new Database.

Required scopes

databases.write

Authentication

Initialize the Appwrite client with setProject() and a server API key (setKey()). For direct REST calls, send X-Appwrite-Project and X-Appwrite-Key.

Parameters

string
Required

Unique Id. Choose a custom ID or generate a random ID with ID.unique(). Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.

string
Required

Database name. Max length: 128 chars.

boolean

Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.

string

Optional description for the database.

Status
Content type
201
application/json

Database

Name
Type
Description
string

Database ID.

string

Database name.

string

Optional description for the database.

string

Database creation date in ISO 8601 format.

string

Database update date in ISO 8601 format.

boolean

If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.

DatabaseType

Database type.

DatabaseStatus

Dedicated database lifecycle status. Null when the database has no valid dedicated backing.

string

Underlying engine of the dedicated backing: postgresql, mysql, or mongodb. A managed product (tablesdb, documentsdb, vectorsdb) reports the engine it runs on, so its type and engine can differ. Null when the database has no dedicated backing.

string

Compute specification identifier of the dedicated backing, e.g. s-2vcpu-2gb. Null when the database has no dedicated backing.

integer

Number of secondary high availability replicas, excluding the primary. Null when backing configuration is unavailable.

string

Error message when the dedicated backing failed. Null when the database has no dedicated backing or has not failed.

string

Container status of the dedicated backing: active, inactive, or failed (a wake was declined because the backing namespace is gone). Null when the database has no dedicated backing or the runtime has not reported one.

string

Idle-lifecycle state of the dedicated backing: active, warm, cold, or hibernated. Null when the database has no dedicated backing or the runtime has not reported one.

arrayof backup

Database backup policies.

Object type

arrayof Archive

Database backup archives.

Object type

GraphQL
mutation {
    databasesCreate(
        databaseId: "<DATABASE_ID>",
        name: "<NAME>",
        enabled: false,
        description: "<DESCRIPTION>"
    ) {
        _id
        name
        description
        _createdAt
        _updatedAt
        enabled
        type
        status
        engine
        specification
        replicas
        error
        containerStatus
        lifecycleState
        policies {
            _id
            name
            _createdAt
            _updatedAt
            services
            resources
            resourceId
            resourceType
            retention
            schedule
            type
            enabled
        }
        archives {
            _id
            _createdAt
            _updatedAt
            policyId
            size
            status
            startedAt
            migrationId
            services
            resources
            resourceId
            resourceType
        }
    }
}