Get reservation details (optional, for debugging)

GET

/v1/reservations/{reservation_id}

Retrieve current status and details of a reservation by ID. Useful for debugging and monitoring long-running operations.
TENANCY (NORMATIVE): - If the reservation exists but is owned by a different effective tenant, the server MUST return 403 FORBIDDEN.

Authorizations

ApiKeyAuth

Type

API Key (header: X-Cycles-API-Key)

Parameters

Path Parameters

reservation_id*

Type

string

Required

Min Length

1

Max Length

128

Responses

Reservation details

Content-Type

application/json

{

  

"reservation_id": "string",

  

"status": "string",

  

"idempotency_key": "string",

  

"subject": "string",

  

"action": {

  

  

"kind": "string",

  

  

"name": "string",

  

  

"tags": [

  

  

  

"string"

  

  

]

  

},

  

"reserved": {

  

  

"unit": "string",

  

  

"amount": 0

  

},

  

"committed": {

  

  

"unit": "string",

  

  

"amount": 0

  

},

  

"created_at_ms": 0,

  

"expires_at_ms": 0,

  

"finalized_at_ms": 0,

  

"scope_path": "string",

  

"affected_scopes": [

  

  

"string"

  

],

  

"metadata": {

  

  

"additionalProperties": "string"

  

}

}

GET

/v1/reservations/{reservation_id}

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

reservation_id*

Samples

Powered by VitePress OpenAPI