Skip to main content
GET
Describe snapshot
Returns a single snapshot, including its completion progress.

Authorization

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

Path parameters

string
required
ID of the snapshot.

Query parameters

string
Subscription that owns the snapshot.

Response

string
ID of the snapshot.
string
ID of the deployment instance the snapshot was taken from.
string
ManualSnapshot or AutomatedSnapshot.
string
Status of the snapshot.
number
Backup progress, from 0 to 100.
boolean
Whether the snapshot is encrypted.
string
Cloud provider that stores the snapshot.
string
Region the snapshot is stored in.
string
Time the snapshot was started.
string
Time the snapshot completed.
string
ID of the service.
string
Name of the service.
string
ID of the product tier.
string
Name of the product tier.
string
Version of the product tier the snapshot was taken on.
string
ID of the subscription that owns the snapshot.
object[]
Custom output parameters recorded with the snapshot.
object
Additional metadata stored for the snapshot.

Errors

See Error for the error response shape.