Get block-storage volume

GET

/block-storage/volumes/: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

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

namestring

size_gbinteger

stateenum

volume_classenum

replica_countinteger

attachmentslist of objects

created_atdatetime

updated_atdatetime

organization_idstringOptional

workspace_idstringOptional

workspace_namestring or nullOptional

site_idstring or nullOptional

site_namestring or nullOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

1	{
2	"id": "string",
3	"name": "string",
4	"size_gb": 1,
5	"state": "creating",
6	"volume_class": "capacity",
7	"replica_count": 1,
8	"attachments": [
9	{
10	"node_name": "string",
11	"mode": "single-writer",
12	"device_path": "string",
13	"attached_at": "2024-01-15T09:30:00Z",
14	"vm_id": "string",
15	"vm_name": "string"
16	}
17	],
18	"created_at": "2024-01-15T09:30:00Z",
19	"updated_at": "2024-01-15T09:30:00Z",
20	"organization_id": "string",
21	"workspace_id": "string",
22	"workspace_name": "string",
23	"site_id": "string",
24	"site_name": "string"
25	}

$	curl -G https://api.ibee.ai/v1/block-storage/volumes/volume_id \
>	-H "Authorization: Bearer <token>" \
>	-d workspace_id=710995