- Docs Home
- Turso Homepage
- Blog & Tutorials
- Discord
- GitHub
Databases
Groups
Locations
Organizations
Members
Invites
Audit Logs
API Tokens
Resources
Retrieve Database
Returns a database belonging to the organization or user.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The name of the organization or user.
The name of the database.
curl -L 'https://api.turso.tech/v1/organizations/{organizationName}/databases/{databaseName}' \
-H 'Authorization: Bearer TOKEN'
{
"database": {
"Name": "my-db",
"DbId": "0eb771dd-6906-11ee-8553-eaa7715aeaf2",
"Hostname": "[databaseName]-[organizationName].turso.io",
"block_reads": true,
"block_writes": true,
"allow_attach": true,
"regions": [
"lhr",
"bos",
"nrt"
],
"primaryRegion": "lhr",
"type": "logical",
"version": "0.22.22",
"group": "default",
"is_schema": true,
"schema": "<string>",
"sleeping": true
}
}Path Parameters
The name of the organization or user.
The name of the database.
Response
The database name, unique across your organization.
The database universal unique identifier (UUID).
The DNS hostname used for client libSQL and HTTP connections.
The current status for blocked reads.
The current status for blocked writes.
The current status for allowing the database to be attached to another.
A list of regions for the group the database belongs to.
The primary region location code the group the database belongs to.
The string representing the object type.
The current libSQL version the database is running.
The name of the group the database belongs to.
If this database controls other child databases then this will be true. See Multi-DB Schemas.
The name of the parent database that owns the schema for this database. See Multi-DB Schemas.
The current status of the database. If true, the database is sleeping and requires a manual wakeup.
Was this page helpful?
curl -L 'https://api.turso.tech/v1/organizations/{organizationName}/databases/{databaseName}' \
-H 'Authorization: Bearer TOKEN'
{
"database": {
"Name": "my-db",
"DbId": "0eb771dd-6906-11ee-8553-eaa7715aeaf2",
"Hostname": "[databaseName]-[organizationName].turso.io",
"block_reads": true,
"block_writes": true,
"allow_attach": true,
"regions": [
"lhr",
"bos",
"nrt"
],
"primaryRegion": "lhr",
"type": "logical",
"version": "0.22.22",
"group": "default",
"is_schema": true,
"schema": "<string>",
"sleeping": true
}
}