CockroachDB · Schema

CreateRestoreRequest

Request body for initiating a cluster restore.

Cluster ManagementCloudDatabaseDistributed SQLInfrastructurePostgreSQL CompatibleSQL

Properties

Name Type Description
backup_id string ID of the backup to restore from.
target object Optional target specification for the restore.
View JSON Schema on GitHub

JSON Schema

cockroachdb-createrestorerequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateRestoreRequest",
  "title": "CreateRestoreRequest",
  "type": "object",
  "description": "Request body for initiating a cluster restore.",
  "required": [
    "backup_id"
  ],
  "properties": {
    "backup_id": {
      "type": "string",
      "description": "ID of the backup to restore from."
    },
    "target": {
      "type": "object",
      "description": "Optional target specification for the restore."
    }
  }
}