Skip to main content
POST
ListVolumes

Authorizations

Authorization
string
header
required

A user session token or personal API key.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json
pageSize
integer<int32>
pageToken
string
names
string[]

Match any listed resource name. Empty filters select all readable volumes.

query
string
creators
string[]
order
enum<string>
Available options:
VOLUME_ORDER_UNSPECIFIED,
VOLUME_ORDER_NAME_ASCENDING,
VOLUME_ORDER_CREATED_DESCENDING,
VOLUME_ORDER_SIZE_ASCENDING,
VOLUME_ORDER_SIZE_DESCENDING
includeCreators
boolean

Include distinct creators across all readable volumes.

includePermissions
boolean

Include permission hints for the returned page; operations still authorize.

Response

Success

volumes
Volume · object[]
nextPageToken
string
creators
string[]
manageableVolumes
string[]

Names from this page the caller may manage, populated with include_permissions.