Skip to main content
GET
Get database.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Path Parameters

databaseId
string
required

Provide databaseId.

Body

application/json
restartIdentity
boolean
default:false

Restart owned identity sequences after truncation. Keep false when generated keys must never be reused.

Response

databaseId
string<uuid>
required
name
string
required
category
string | null
required
desc
string | null
required
tags
string[] | null
required
restricted
boolean
required
audit
boolean
required

Whether future row mutations are captured for this logical table.

type
enum<string>
required
Available options:
TABLE,
TABLE_PARTITIONED
definition
object[]
required
partition
object | null
required
groups
object[]
required
users
object[]
required
parent
string | null
required
master
string | null
required
version
number
required
createdBy
string<uuid>
required
createdAt
string<date-time>
required
lastUpdateBy
string<uuid>
required
lastUpdateAt
string<date-time>
required
deletedAt
string<date-time> | null
required
deletedBy
string<uuid> | null
required
metadata
object
Last modified on September 5, 2026