Run full backup of a CockroachDB instance

This API is used to run a full backup of CockroachDB instance.

application/json

Request Body

• taskInfo object

  task object

  taskType integer

  associations object[]

  clientName string

  instanceName string

  displayName string

  backupsetId integer

  _type_ string

  commCellName string

  instanceId integer

  csGUID string

  subclientGUID string

  subclientId integer

  clientId integer

  appName string

  backupsetName string

  applicationId integer

  subclientName string

  entityInfo object

  companyId integer

  companyName string

  subTasks object[]

  subTask object

  subTaskType integer

  operationType integer

  options object

  backupOpts object

  backupLevel string

  dataOpt object

  createNewIndex boolean

  commonOpts object

  notifyUserOnJobCompletion boolean

Responses

• 200
• 400
• 401
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• taskId integer
• jobIds string[]

{
  "taskId": 0,
  "jobIds": [
    "string"
  ]
}

{
  "taskId": 1328,
  "jobIds": [
    "8840"
  ]
}

Bad Request

application/json

• Schema
• Example 1

---

Schema

• string

Request body is empty or format is invalid

Unauthorized

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

Not Found

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "No instance is specified",
  "errorCode": 4
}

Loading...