List block-storage volumes

GET

/block-storage/volumes

GET

/v1/block-storage/volumes

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

1 [
2   {
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 ]

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.

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

Volumes 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