Turso home page

tursodatabase/libsql
API Status
Dashboard
tursodatabase/libsql

Databases

List Databases

Docs Home
Turso Homepage
Blog & Tutorials
Discord
GitHub

API

Resources

Databases

GET
List
POST
Create
GET
Retrieve
GET
Retrieve Configuration
PATCH
Update Configuration
GET
Usage
GET
Stats
DEL
Delete
GET
List Instances
GET
Retrieve Instance
POST
Create Token
POST
Invalidate Tokens
POST
Upload Dump

Groups

Locations

Organizations

Members

Invites

Audit Logs

API Tokens

Databases

List Databases

Returns a list of databases belonging to the organization or user.

GET

organizations

{organizationName}

databases

Authorization

string

Bearer

Authorization

Required

string

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

organizationName

string

organizationName

Required

string

The name of the organization or user.

group

string

group

string

Filter databases by group name.

Path Parameters

organizationName

string

required

The name of the organization or user.

Query Parameters

group

string

Filter databases by group name.

Response

200 - application/json

databases

object[]

databases.Name

string

The database name, unique across your organization.

databases.DbId

string

The database universal unique identifier (UUID).

databases.Hostname

string

The DNS hostname used for client libSQL and HTTP connections.

databases.block_reads

boolean

The current status for blocked reads.

databases.block_writes

boolean

The current status for blocked writes.

databases.allow_attach

boolean

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

databases.regions

string[]

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

databases.primaryRegion

string

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

databases.type

string

default: logical

The string representing the object type.

databases.version

string

The current libSQL version the database is running.

databases.group

string

The name of the group the database belongs to.

databases.is_schema

boolean

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

databases.schema

string

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

databases.sleeping

boolean

The current status of the database. If true, the database is sleeping and requires a manual wakeup.

Was this page helpful?

Errors Create

discord github twitter linkedin