Detach block-storage volume

POST

/block-storage/volumes/:volume_id/detach

POST

/v1/block-storage/volumes/:volume_id/detach

$ curl -X POST "https://api.ibee.ai/v1/block-storage/volumes/volume_id/detach?workspace_id=710995" \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "node_name": "string"
> }'

1 {
2   "volume": {
3     "id": "string",
4     "name": "string",
5     "size_gb": 1,
6     "state": "creating",
7     "volume_class": "capacity",
8     "replica_count": 1,
9     "attachments": [
10       {
11         "node_name": "string",
12         "mode": "single-writer",
13         "device_path": "string",
14         "attached_at": "2024-01-15T09:30:00Z",
15         "vm_id": "string",
16         "vm_name": "string"
17       }
18     ],
19     "created_at": "2024-01-15T09:30:00Z",
20     "updated_at": "2024-01-15T09:30:00Z",
21     "organization_id": "string",
22     "workspace_id": "string",
23     "workspace_name": "string",
24     "site_id": "string",
25     "site_name": "string"
26   },
27   "operation": {
28     "id": "string",
29     "volume_id": "string",
30     "operation": "create",
31     "status": "in-progress",
32     "created_at": "2024-01-15T09:30:00Z",
33     "started_at": "2024-01-15T09:30:00Z",
34     "idempotency_key": "string",
35     "result": {},
36     "error": "string",
37     "completed_at": "2024-01-15T09:30:00Z"
38   }
39 }

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.

Request

This endpoint expects an object.

node_namestringRequired>=1 character

forcebooleanOptionalDefaults to false

confirm_unmountedbooleanOptionalDefaults to false

vm_stateenum or nullOptional

vm_typeenumOptionalDefaults to cloud

reasonstring or nullOptional

idempotency_keystring or nullOptional

Response

Volume detached successfully.

volumeobject

operationobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error