Volume 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 volume |
created_at | string (date-time) | No | When the volume was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the volume was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | Display name of the volume |
type | enum | No | The kind of volume Values: STANDARD, HIGH_PERFORMANCE, SHARED, LOCAL, OTHER |
status | enum | No | Normalized volume status Values: CREATING, AVAILABLE, IN_USE, DELETING, ERROR, OTHER |
size_mb | number | No | Provisioned size in MiB |
used_mb | number | No | Used space in MiB |
region_id | string | No | The region the volume lives in |
availability_zone | string | No | The availability zone within the region, where the vendor places volumes per zone |
instance_ids | string[] | No | Instances the volume is mounted on |
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