Snapshot data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the snapshot |
created_at | string (date-time) | No | When the snapshot was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the snapshot was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | Display name of the snapshot |
instance_id | string | No | The instance the snapshot was taken from |
volume_id | string | No | The volume the snapshot was taken from |
type | enum | No | Whether memory state is included Values: MEMORY, DISK, OTHER |
status | enum | No | Normalized snapshot status Values: CREATING, READY, FAILED, DELETING, OTHER |
size_mb | number | No | Snapshot size in MiB |
expires_at | string (date-time) | No | When the snapshot will be deleted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metadata | ComputeMetadata[] | No | Vendor labels, tags and metadata |
metadata[].id | string | No | |
metadata[].slug | string | No | The label, tag or metadata key |
metadata[].value | object | No | The label, tag or metadata value |
metadata[].namespace | string | No | The origin of the value (eg. labels, tags, metadata) |
metadata[].format | enum | No | The data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No |
Are we missing anything? Let us know