Skip to main content
GET
List reservations

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

ids
string<uuid>[]

Comma-separated reservation IDs, supplied once. Intersects the other filters and your organization access. Missing or inaccessible reservations are omitted; repeated IDs return one record. Pass limit=100 to retrieve a full batch in one page.

Required array length: 1 - 100 elements
status
enum<string>

Filter by reservation status.

Available options:
confirmed,
active,
completed,
cancelled
limit
integer
default:50

Page size, at most 100. Defaults to 50.

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

Opaque nextCursor from the preceding response.

deployed
boolean

Filter by whether the reservation has been deployed.

endsAtNull
boolean

Filter by whether the reservation has no end time.

listingId
string<uuid>

Filter by listing ID.

listingTermId
string<uuid>

Filter by listing term ID.

customerId
string<uuid>

Customer filter; cannot widen your organization access.

Response

One page of visible reservations. This example is the last page.

reservations
object[]
required
nextCursor
string | null

Pass unchanged as cursor on the next request. Absent, null, or empty means the last page.