GET
List Volumes

Authorizations

Authorization
string
header
required

The access token from a signed-in console session, sent as Authorization: Bearer <token>. It must be issued for the Simnet API audience — an identity token, or a token for another application, is refused with 401.

There are no API keys, client secrets or service accounts yet, so this is a personal, short-lived credential carrying your full account access. Programmatic credentials with role-based access are on the roadmap. See Authentication.

Headers

X-Region-Context
string<uuid>

The region to run this request against, as a region UUID. Omit it to use your default region — your primary region if you have one, otherwise the first active one. See Regions.

Query Parameters

id
string
keyword
string
name
string
type
string
state
string
zoneId
string
virtualMachineId
string
diskOfferingId
string
hostId
string
podId
string
clusterId
string
storageId
string
account
string
domainId
string
isRecursive
boolean
listAll
boolean
tags
string
projectId
string
page
integer<int32>
default:1
pageSize
integer<int32>
default:20

Response

Block storage volumes, attached and detached.

A pass-through list envelope. The rows are under volumes — the compute platform's own key — not content.

volumes
object[]

The rows on this page.

count
integer

Total rows matching the query, across all pages.

page
integer

The page you are on, counting from 1.

Example:

1

pageSize
integer
Example:

20