Restore

Restore interface

Changed on

Submit a request to restore the data from backup

post/restore_secondary

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Headers

request_idstring

request_id

Request body

asyncboolean

Async or not: return after the job is registered instead of waiting for it to settle.

backup_namestring

Backup name to restore.

pathstring

Path, overriding the config for this call.

requestIdstring

Uuid of request; doubles as the restore task id.

sourceClusterIDstring

Cdc source cluster id.

targetClusterIDstring

Cdc target cluster id.

Response

OK

code0 | 1 | 2 | 3 | 400 | 404 | 503
msgstring

Error msg if fail.

requestIdstring

Uuid of the request answered; absent on the failures a request answers before its id is known.

Changes