Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

destination_cluster_id
string
required

The ID of the cluster where the backup will be restored.

Body

application/json
type
enum<string>
required
Available options:
CLUSTER,
DATABASE,
TABLE
backup_id
string

The ID of the backup from which data will be restored. If backup_id is not set, the restore will use the latest available backup from source_cluster_id.

objects
object[]

The list of objects to restore. Required when type is DATABASE or TABLE.

restore_opts
object
source_cluster_id
string

The ID of the cluster containing the backup to be restored.

Response

A successful response.

backup_end_time
string<date-time>
required

The timestamp at which the backup data was captured.

backup_id
string
required

The ID of the backup used for this restore job.

completion_percent
number<float>
required

The percentage of the restore job that has been completed. The value ranges from 0 to 1.

created_at
string<date-time>
required

The time at which the restore job was initiated.

destination_cluster_name
string
required

The name of the cluster to which the restore is being applied.

id
string
required

The unique identifier associated with the restore.

source_cluster_name
string
required

The name of the cluster from which the backup was taken.

status
enum<string>
required
Available options:
PENDING,
SUCCESS,
FAILED
type
enum<string>
required
Available options:
CLUSTER,
DATABASE,
TABLE
client_error_code
integer<int32>

Error code from the restore job, only populated if it has failed.

client_error_message
string

Error message from the restore job, only populated if it has failed.

completed_at
string<date-time>

The timestamp at which the restore job completed.

crdb_job_id
string

The CockroachDB internal job ID for the restore job.

objects
object[]

The list of database objects (databases, tables) that were restored.

restore_opts
object