Skip to navigation

List block-volume operations

Lists the operations run on a block storage volume and their status. 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/operations?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

Operations returned successfully.
idstring
Unique ID of the operation.
volume_idstring
Volume the operation acts on.
operationenum
  • create
  • attach
  • detach
  • resize
  • delete
Allowed values:
statusenum
  • in-progress: running.
  • succeeded: finished successfully.
  • failed: finished with an error; see error.
Allowed values:
created_atdatetime

When the operation was accepted (ISO 8601).

started_atdatetime

When the operation started (ISO 8601).

idempotency_keystring or nullOptional
Idempotency key the request was made with, when one was given.
resultmap from strings to anyOptional

Operation-specific result details as key-value data.

errorstring or nullOptional

Error detail when status is failed.

completed_atdatetime or nullOptional

When the operation finished (ISO 8601); null while running.

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