Skip to navigation

Detach a volume from a GPU VM

Detaches a persistent block storage volume from a GPU VM. Stop jobs using it and unmount its filesystem in the guest first unless force is used. Asynchronous: the response carries operation_id; poll GET /compute/operations/{operation_id} until status is succeeded, failed, cancelled or timed_out. If your client times out, read the status; never resubmit the request. Requires scope: vm.write.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# VM_ID: Virtual machine ID
curl -X POST "https://api.ibee.ai/v1/compute/gpu-vms/$VM_ID/actions/detach-volume?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN" \
-H "X-Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"volume_id": "<volume_id>"}'

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

vm_idstringRequired
Virtual machine ID.

Headers

X-Idempotency-KeystringRequired
Unique key used to safely retry write operations.

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.

Request

This endpoint expects an object.
volume_idstringRequired>=1 character
ID of the block storage volume to detach.
forcebooleanOptionalDefaults to false
Detach even if the volume still appears to be in use. Default false.
confirm_unmountedbooleanOptionalDefaults to false
Confirms the volume was unmounted inside the guest. Default false.

Response

Volume detachment accepted.
operation_idstring
ID of the queued operation.
vm_idstring
ID of the VM the operation acts on.
statusstring

Always accepted.

submitted_atdatetime

When the operation was accepted (ISO 8601).

Errors

400
Bad Request Error
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