Skip to main content
GET
List volumes
CLI equivalent: ornn volumes list --limit 25 --format json.

Authorizations

Authorization
string
header
required

Create an organization API key in Account Settings > Developer. Do not send this key to the Kubernetes API server.

Query Parameters

limit
integer

Page size from 1 to 100. Defaults to 15.

Required range: 1 <= x <= 100
cursor
string

Opaque next_cursor from the previous page, sent with the same filters.

q
string

Case-insensitive text matched against volume name, ID, and region. At most 256 characters.

Maximum string length: 256
deployment
enum<string>
default:all

Filter by whether the volume is mounted on a machine.

Available options:
all,
deployed,
available
reservation_id
string<uuid>

An owned reservation. Returns that reservation's attached volume and attachment instead of a page. Cannot be combined with other query parameters.

Response

A page of volumes, or the reservation's attachment when reservation_id is set. Ignore fields you do not recognize.

drives
object[]
required
next_cursor
string | null

Pass unchanged as cursor, with the same filters. null means the last page.