Skip to main content
GET
List reservations

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

metric_name
string

Metric name for the resource (e.g., 'bm1-hf-medium_min')

order_by
enum<string>
default:active_from.desc

Order by field and direction.

Available options:
active_from.asc,
active_from.desc,
active_to.asc,
active_to.desc
Examples:

"active_from.asc"

"active_to.asc"

region_id
integer

Region for reservation

show_inactive
boolean
default:true
deprecated

Include inactive commits in the response. Only applies when no period is given; ignored when 'time_from'/'time_to' are supplied, since the period defines the window.

time_from
string<date-time>

Start of the reservation period (ISO 8601). Must be supplied together with 'time_to'. When both are given, period-matched monthly pricing is returned and the period must be at most one month (31 days). When both are omitted, current pricing is returned.

Example:

"2025-01-01T00:00:00Z"

time_to
string<date-time>

End of the reservation period (ISO 8601). Must be supplied together with 'time_from'. When both are given, period-matched monthly pricing is returned and the period must be at most one month (31 days). When both are omitted, current pricing is returned.

Example:

"2025-02-01T00:00:00Z"

Response

200 - application/json

OK

count
integer
required

Number of objects

Required range: x >= 0
Example:

1

results
BillingReservationV2ItemResponseSerializer · object[]
required

Objects