Turso home page

tursodatabase/libsql
API Status
Dashboard
tursodatabase/libsql

Databases

List Databases

API

Introduction
Quickstart
Authentication
Errors

Resources

Databases
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

{organizationSlug}

databases

Authorization

string

Bearer

Authorization

Required

string

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

organizationSlug

string

organizationSlug

Required

string

The slug of the organization or user account.

group

string

group

string

Filter databases by group name.

schema

string

schema

string

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

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

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

boolean

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

Was this page helpful?

Errors Create

discord github twitter linkedin