Create a NEW volume from a volume recovery point.
curl --request POST \ --url https://stratum.example.com/v1/backup/admin/recovery-points/example/restore-to-new-volume \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "ageIdentity": "example", "name": "example", "projectId": "example", "sizeBytes": 1, "storageClass": "example", "availabilityZone": "example" }'Cedar action backup:Manage. restore a volume whose
row no longer exists (deleted, or a fresh cluster) by minting a NEW
volume and importing the backup into it. This is the create-from-backup
analogue of the in-place restore-from (which needs the row to
still exist).
Given a volume-scoped recoveryPointId and the operator’s off-cluster
age identity, the control plane fetches the bundle from the configured
volume target, decrypts it in memory (the identity is transient — never
persisted or logged), and imports it into a fresh volume. The new
volume’s shape (name/projectId/sizeBytes/storageClass) defaults from the
bundle manifest’s source; supply any field to override, or all of them
when restoring a pre- bundle that lacks the source metadata.
400 on a bad body/identity, a non-volume recovery point, missing
required shape fields, or an empty/truncated source stream;
404 when the recovery point or its bundle is missing; 422
(BackupRefused) when the target class’s driver cannot import it, or
the point is an incremental chain it cannot apply. A new
node-local (lvm-thin) volume lands on this control plane’s node.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
The operator’s off-cluster age private key (“AGE-SECRET-KEY-1…”). Used only in memory; never stored.
New volume name (defaults to the source volume’s name).
Owning project (defaults to the source volume’s project).
New volume size (defaults to the source volume’s size).
Storage class (defaults to the source volume’s class).
AZ (defaults to the install default).
Example generated
{ "ageIdentity": "example", "name": "example", "projectId": "example", "sizeBytes": 1, "storageClass": "example", "availabilityZone": "example"}Responses
Section titled “Responses”Accepted — validated synchronously; the import runs asynchronously.
volumeId is the pre-allocated new volume id (the row appears once
the import succeeds — poll operationId, then GET the volume).
object
Storage.volume.restore operation to poll for progress/outcome.
Example
{ "status": "accepted"}INVALID_BODY / INVALID_INPUT — a malformed body or identity, a
non-volume or unrestorable recovery point, missing shape fields, or
an empty/truncated stream. ENCRYPTED_RESTORE_IN_PLACE_ONLY
— the recovery point holds an encrypted volume, which only that
volume’s key opens: restore it in place onto that volume.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
Field errors, for codes that carry them: each problem at its field
(see FieldError). Documented on the responses that set it, e.g.
approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED.
Absent otherwise.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
Structured facts about the refusal, for codes that carry them. The
shape is fixed per code and documented on the response that answers
it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and
IMAGE_IN_USE. Absent for codes that carry none.
object
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}Resource not found.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
Field errors, for codes that carry them: each problem at its field
(see FieldError). Documented on the responses that set it, e.g.
approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED.
Absent otherwise.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
Structured facts about the refusal, for codes that carry them. The
shape is fixed per code and documented on the response that answers
it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and
IMAGE_IN_USE. Absent for codes that carry none.
object
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}The volume backup or restore cannot run on this control plane, refused
before anything is started. code says why:
BACKUP_UNSUPPORTED— the volume’s (or the target class’s) storage driver cannot export or import a backup.VOLUME_NOT_ON_THIS_NODE— the volume is node-local (lvm-thin) and on another node than the control plane that took the request; a node-local volume is backed up and restored only on its own node. Send the request to that node’s control plane.CHAIN_RESTORE_UNSUPPORTED— an incremental (base/diff) recovery point onto a driver that cannot apply a diff chain (lvm-thin). Restore a full recovery point instead.
A plan run, which backs up later on the leader, cannot refuse up front:
the same BACKUP_UNSUPPORTED / VOLUME_NOT_ON_THIS_NODE arrive as the
failed recovery point’s errorCode and its operation’s error code.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
Field errors, for codes that carry them: each problem at its field
(see FieldError). Documented on the responses that set it, e.g.
approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED.
Absent otherwise.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
Structured facts about the refusal, for codes that carry them. The
shape is fixed per code and documented on the response that answers
it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and
IMAGE_IN_USE. Absent for codes that carry none.
object
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}