Skip to navigation

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.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# VOLUME_ID: Workspace-owned block-volume ID
curl "https://api.ibee.ai/v1/block-storage/volumes/$VOLUME_ID?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

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_idstringRequired>=1 character

Workspace-owned block-volume ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Response

Volume returned successfully.
idstring
Unique ID of the volume.
namestring
Display name of the volume.
size_gbinteger
Size in GB.
stateenum

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 its error.
volume_classenum

Performance class of the volume.

  • capacity: lowest cost per GB.
  • balanced: general purpose.
  • performance: highest throughput and IOPS.
Allowed values:
replica_countinteger
Number of synchronous replicas kept for the volume.
attachmentslist of objects

Current attachments; empty when detached.

created_atdatetime

When the volume was created (ISO 8601).

updated_atdatetime

When the volume was last changed (ISO 8601).

organization_idstringOptional
ID of the owning organization.
workspace_idstringOptional
ID of the owning workspace.
workspace_namestring or nullOptional
Display name of the workspace.
site_idstring or nullOptional
Site the volume lives at.
site_namestring or nullOptional
Display name of that site.
metadataobjectOptional

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