List Databases

GET

organizations

{organizationSlug}

databases

curl -L https://api.turso.tech/v1/organizations/{organizationSlug}/databases \
  -H 'Authorization: Bearer TOKEN'

{
  "databases": [
    {
      "Name": "my-db",
      "DbId": "0eb771dd-6906-11ee-8553-eaa7715aeaf2",
      "Hostname": "[databaseName]-[organizationSlug].turso.io",
      "block_reads": false,
      "block_writes": false,
      "allow_attach": false,
      "regions": [
        "lhr",
        "bos",
        "nrt"
      ],
      "primaryRegion": "lhr",
      "type": "logical",
      "version": "0.22.22",
      "group": "default",
      "is_schema": false,
      "schema": "",
      "archived": false
    }
  ]
}

curl -L https://api.turso.tech/v1/organizations/{organizationSlug}/databases \
  -H 'Authorization: Bearer TOKEN'

Path Parameters

organizationSlug

string

required

The slug of the organization or user account.

Query Parameters

group

string

Filter databases by group name.

schema

string

The schema database name that can be used to get databases that belong to that parent schema.

Response

200 - application/json

Successful response

databases

object[]

databases.Name

string

The database name, unique across your organization.

Example:

"my-db"

databases.DbId

string

The database universal unique identifier (UUID).

Example:

"0eb771dd-6906-11ee-8553-eaa7715aeaf2"

databases.Hostname

string

The DNS hostname used for client libSQL and HTTP connections.

Example:

"[databaseName]-[organizationSlug].turso.io"

databases.block_reads

boolean

The current status for blocked reads.

Example:

false

databases.block_writes

boolean

The current status for blocked writes.

Example:

false

databases.allow_attach

boolean

The current status for allowing the database to be attached to another.

Example:

false

databases.regions

string[]

A list of regions for the group the database belongs to.

Example:

["lhr", "bos", "nrt"]

databases.primaryRegion

string

The primary region location code the group the database belongs to.

Example:

"lhr"

databases.type

string

default:logical

The string representing the object type.

Example:

"logical"

databases.version

string

The current libSQL version the database is running.

Example:

"0.22.22"

databases.group

string

The name of the group the database belongs to.

Example:

"default"

databases.is_schema

boolean

If this database controls other child databases then this will be true. See Multi-DB Schemas.

Example:

false

databases.schema

string

The name of the parent database that owns the schema for this database. See Multi-DB Schemas.

Example:

""

databases.archived

boolean

The current status of the database. If true, the database is archived and requires a manual unarchive step.

Example:

false

Was this page helpful?

Suggest edits Raise issue

Errors Create

curl -L https://api.turso.tech/v1/organizations/{organizationSlug}/databases \
  -H 'Authorization: Bearer TOKEN'

{
  "databases": [
    {
      "Name": "my-db",
      "DbId": "0eb771dd-6906-11ee-8553-eaa7715aeaf2",
      "Hostname": "[databaseName]-[organizationSlug].turso.io",
      "block_reads": false,
      "block_writes": false,
      "allow_attach": false,
      "regions": [
        "lhr",
        "bos",
        "nrt"
      ],
      "primaryRegion": "lhr",
      "type": "logical",
      "version": "0.22.22",
      "group": "default",
      "is_schema": false,
      "schema": "",
      "archived": false
    }
  ]
}

API

Resources

Organizations

API Tokens

List Databases

Path Parameters

Query Parameters

Response