Skip to main content
PUT
Update database.

Authorizations

Authorization
string
header
required

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

Path Parameters

databaseId
string
required

Provide databaseId.

Body

application/json
version
number
required

Provide current version.

audit
boolean

Enable or disable future row audit capture for the logical table.

name
string

Name.

Required string length: 1 - 60
category
string

Category.

Maximum string length: 30
desc
string

Description.

Maximum string length: 1000
metadata
object

Replacement resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

restricted
boolean

Provide if access should be restricted.

groups
string[]

Provide which groups should have access to it, once restricted is true.

users
string[]

Provide which users should have access to it, once restricted is true.

definition
object[]

Database definitions.

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