Skip to navigation
API Referenceblock-storage

List block storage volumes

Returns block storage volumes for the authenticated account. Optionally filter by virtual machine.

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Query parameters

vmIdstringOptional
Filter volumes attached to a specific virtual machine
pageintegerOptional>=1

Page number, 1-indexed. Defaults to 1 when omitted.

pageSizeintegerOptional1-500

Items per page. Defaults to 100 when omitted; server cap 500.

Response

totaldouble

Total number of items matching the request, across all pages. Use this together with pageSize to compute how many pages exist.

datalist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error