Skip to main content
POST
Restore from snapshot
Restores a snapshot into a new deployment instance. The original instance is left untouched. Restoring is asynchronous: the response returns the new instance ID, which starts in DEPLOYING and becomes RUNNING when the restore completes.

Authorization

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

Path parameters

string
required
ID of the snapshot to restore.

Query parameters

string
Subscription that owns the snapshot.

Body

string
Network type for the restored instance, for example PUBLIC.
string
ID of the custom network to restore into.
Request

Response

Returns 202 Accepted.
string
ID of the restored deployment instance.
202 Accepted

Errors

See Error for the error response shape.