Get block-storage volume
Returns a block storage volume, including its size, status, and the VM it is attached to. Requires scope: block-storage.read.
Authentication
AuthorizationBearer
IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.
Path parameters
volume_id
Workspace-owned block-volume ID.
Query parameters
workspace_id
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Response
Volume returned successfully.
id
Unique ID of the volume.
name
Display name of the volume.
size_gb
Size in GB.
state
Lifecycle state of the volume.
creating: being provisioned.ready: provisioned and detached.in-use: attached to a node.attaching,detaching: an attachment change is in progress.resizing: a resize is in progress.deleting: being removed.error: the last operation failed; see itserror.
volume_class
Performance class of the volume.
capacity: lowest cost per GB.balanced: general purpose.performance: highest throughput and IOPS.
Allowed values:
replica_count
Number of synchronous replicas kept for the volume.
attachments
Current attachments; empty when detached.
created_at
When the volume was created (ISO 8601).
updated_at
When the volume was last changed (ISO 8601).
organization_id
ID of the owning organization.
workspace_id
ID of the owning workspace.
workspace_name
Display name of the workspace.
site_id
Site the volume lives at.
site_name
Display name of that site.
metadata
Additional key-value data, including the billing_catalog the volume was created with.
Errors
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error
