Skip to navigation

Delete block-storage volume

Permanently deletes a block storage volume and its data. Asynchronous: the response carries the volume operation; poll GET /block-storage/volumes/{volume_id}/operations until its status is succeeded or failed. Requires scope: block-storage.write.

# 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 -X DELETE "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.

forcebooleanOptionalDefaults to false
Delete the volume even if it is still attached. Default false.

Response

Volume deletion completed.
statusenum

Always deleted.

Allowed values:
idstring
ID of the deleted volume.
operation_idstring
ID of the delete operation.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error
423
Locked Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error