Skip to main content
POST
Create snapshot
Creates a manual snapshot of a deployment instance. Snapshotting is asynchronous: the call returns immediately and the snapshot progresses from pending to completed. Poll Describe snapshot to follow the progress field.

Authorization

Session cookie set by Sign in: omnistrate_token=<jwt>.

Query parameters

string
Subscription that owns the instance. Required when you belong to more than one subscription.

Body

string
required
ID of the deployment instance to snapshot.
string
Region to store the snapshot in. Defaults to the instance region.
Request

Response

Returns 202 Accepted.
string
ID of the orchestration that creates the snapshot.

Errors

See Error for the error response shape.