Retrieve Database

GET

organizations

{organizationSlug}

databases

{databaseName}

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

{
  "database": {
    "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/{databaseName}' \
-H 'Authorization: Bearer TOKEN'

Path Parameters

organizationSlug

string

required

The slug of the organization or user account.

databaseName

string

required

The name of the database.

Response

200

application/json

Successful response

database

object

database.Name

string

The database name, unique across your organization.

Example:

"my-db"

database.DbId

string

The database universal unique identifier (UUID).

Example:

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

database.Hostname

string

The DNS hostname used for client libSQL and HTTP connections.

Example:

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

database.block_reads

boolean

The current status for blocked reads.

Example:

false

database.block_writes

boolean

The current status for blocked writes.

Example:

false

database.allow_attach

boolean

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

Example:

false

database.regions

string[]

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

Example:

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

database.primaryRegion

string

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

Example:

"lhr"

database.type

string

default:logical

The string representing the object type.

Example:

"logical"

database.version

string

The current libSQL version the database is running.

Example:

"0.22.22"

database.group

string

The name of the group the database belongs to.

Example:

"default"

database.is_schema

boolean

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

Example:

false

database.schema

string

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

Example:

""

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

Create Retrieve Configuration

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

{
  "database": {
    "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

Retrieve Database

Path Parameters

Response