Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <api_key>. The legacy Authorization: Api-Key <api_key> scheme is also accepted.

Path Parameters

volume_namespace
string
required
volume_name
string
required
volume_version
string
required

Body

application/json
expected_sequence
integer | null

Revision the volume is expected to be at. When set, the restore fails with a conflict if the volume has changed since. Take the value from volume_sequence.

Response

200 - application/json
namespace
string
required

Namespace the volume belongs to, in lowercase.

volume
string
required

Name of the volume, in lowercase.

version_ref
string
required

Full address of the restored version, as bdn:<namespace>/<volume>@<digest>.

digest
string
required

Content digest of the restored version, as b3:<hex>.

lifecycle
string
required

Lifecycle state of the version after the restore.

volume_sequence
integer
required

Revision of the volume after the restore.