Skip to main content
POST
Clone database.

Authorizations

Authorization
string
header
required

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

Path Parameters

databaseId
string
required

Provide databaseId.

Body

application/json
audit
boolean

Optional audit override. Defaults to the source logical table setting.

name
string

Optional target root database name. Defaults to the source database name with "_Clone" suffix.

Required string length: 1 - 60
suffix
string

Suffix used for automatically generated clone names. Defaults to "Clone".

Required string length: 1 - 30
includeItems
boolean

Whether to copy existing rows/items into the clone. Defaults to false.

includeData
boolean

Alias for includeItems. Defaults to false.

includePartitions
boolean

Whether to clone connected table partitions. Defaults to true.

category
string

Optional cloned database category override.

Maximum string length: 30
desc
string

Optional cloned database description override.

Maximum string length: 1000
tags
string[]

Optional cloned database tags override.

restricted
boolean

Optional cloned database restricted flag override.

groups
string[]

Optional cloned database group access override.

users
string[]

Optional cloned database user access override.

Response

accepted
boolean
required
databaseId
string<uuid>
required
sourceDatabaseId
string<uuid>
required
cloneId
string<uuid>
required
name
string
required
includeItems
boolean
required
includePartitions
boolean
required
audit
boolean
required

Resolved audit setting applied to the cloned logical table.

message
string
required
Last modified on September 5, 2026