> ## Documentation Index > Fetch the complete documentation index at: https://docs.nscale.com/llms.txt > Use this file to discover all available pages before exploring further. # List reservations > List reservations. ## OpenAPI ````yaml /openapi/reservation-openapi.yaml get /api/v2/reservations openapi: 3.0.3 info: title: Unikorn Reservation API description: |- Reservation service provides topology-aware bare metal GPU reservation and placement, sitting atop UNI Region service resources. version: 0.5.0 servers: - url: https://reservation.nks.europe-west4.nscale.com description: Production - url: https://reservation.nks-stg.europe-west2.nscale.com description: Staging - url: https://reservation.nks-dev.glo1.nscale.com description: Development security: [] paths: /api/v2/reservations: description: |- Manages project scoped reservations of one or more contiguous accelerator reservation units in a region. get: tags: - Reservations summary: List reservations description: List reservations. operationId: listReservations parameters: - $ref: '#/components/parameters/tagSelectorParameter' - $ref: '#/components/parameters/organizationIDQueryParameter' - $ref: '#/components/parameters/projectIDQueryParameter' - $ref: '#/components/parameters/regionIDQueryParameter' responses: '200': $ref: '#/components/responses/reservationsV2Response' '400': $ref: '#/components/responses/badRequestResponse' '401': $ref: '#/components/responses/unauthorizedResponse' '403': $ref: '#/components/responses/forbiddenResponse' '500': $ref: '#/components/responses/internalServerErrorResponse' security: - oauth2Authentication: [] components: parameters: tagSelectorParameter: name: tag in: query description: |- A set of tags to match against resources in the form "name=value", thus when encoded you get "?tag=foo%3Dcat&tag=bar%3Ddog". schema: type: array items: type: string organizationIDQueryParameter: name: organizationID in: query description: Allows resources to be filtered by organization. schema: type: array items: type: string projectIDQueryParameter: name: projectID in: query description: Allows resources to be filtered by project. schema: type: array items: type: string regionIDQueryParameter: name: regionID in: query description: Allows resources to be filtered by region. schema: type: array items: type: string responses: reservationsV2Response: description: A list of reservations. content: application/json: schema: $ref: '#/components/schemas/reservationsV2Read' example: - metadata: id: a64f9269-36e0-4312-b8d1-52d93d569b7b name: gb300-nvl72 organizationId: 9a8c6370-4065-4d4a-9da0-7678df40cd9d projectId: e36c058a-8eba-4f5b-91f4-f6ffb983795c creationTime: '2026-04-28T10:45:45Z' createdBy: john.doe@example.com provisioningStatus: provisioned healthStatus: healthy tags: - name: workload value: training spec: regionId: c7568e2d-f9ab-453d-9a3a-51375f78426b accelerator: GB300 unit: NVL72 count: 2 status: machineFlavorId: g.72.gb300.pinned claimedUnitCount: 2 topologyHash: >- sha256:4fd768f7a87c07aa81e7af8a765cdeaa0f7fe671052f3acbeec918522d026d2e topologyObservedAt: '2026-05-14T10:00:00Z' badRequestResponse: description: |- Request body failed schema validation, or the request does not contain all the required fields. content: application/json: schema: $ref: '#/components/schemas/error' example: error: invalid_request error_description: request body invalid trace_id: 57bc14d9bd461f0b5a72db830149b67a unauthorizedResponse: description: Authentication failed or the access token has expired. content: application/json: schema: $ref: '#/components/schemas/error' example: error: access_denied error_description: authentication failed trace_id: 57bc14d9bd461f0b5a72db830149b67a forbiddenResponse: description: >- Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform. content: application/json: schema: $ref: '#/components/schemas/error' example: error: forbidden error_description: user credentials do not have the required privileges trace_id: 57bc14d9bd461f0b5a72db830149b67a internalServerErrorResponse: description: >- An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue. content: application/json: schema: $ref: '#/components/schemas/error' example: error: server_error error_description: failed to token claim trace_id: 57bc14d9bd461f0b5a72db830149b67a schemas: reservationsV2Read: description: A list of reservations. type: array items: $ref: '#/components/schemas/reservationV2Read' error: description: Generic error message, compatible with oauth2. type: object required: - error - error_description properties: error: description: >- A terse error string expanding on the HTTP error code. Errors are based on the OAuth 2.02 specification, but are expanded with proprietary status codes for APIs other than those specified by OAuth 2.02. type: string enum: - invalid_request - server_error - access_denied - not_found - conflict - method_not_allowed - unsupported_media_type - request_entity_too_large - unprocessable_content - forbidden error_description: description: Verbose message describing the error. type: string trace_id: description: Unique trace identifier for the request. type: string reservationV2Read: description: A reservation. type: object required: - metadata - spec - status properties: metadata: $ref: '#/components/schemas/projectScopedResourceReadMetadata' spec: $ref: '#/components/schemas/reservationV2Spec' status: $ref: '#/components/schemas/reservationV2Status' projectScopedResourceReadMetadata: description: Metadata required by project scoped resource reads. allOf: - $ref: '#/components/schemas/organizationScopedResourceReadMetadata' - type: object required: - projectId properties: projectId: description: The project identifier the resource belongs to. type: string reservationV2Spec: description: A reservation's specification. type: object required: - regionId - accelerator - unit - count properties: regionId: description: The region to reserve capacity in. type: string accelerator: description: Public accelerator model or family to reserve. type: string unit: description: Public reservation granularity to reserve. type: string count: description: Number of reservation units to reserve. type: integer minimum: 1 reservationV2Status: description: Read only status information about a reservation. type: object required: - machineFlavorId - claimedUnitCount properties: machineFlavorId: description: Resolved Region machine flavor used for pinned servers. type: string claimedUnitCount: description: Number of reservation units successfully claimed. type: integer minimum: 0 topologyHash: description: Hash of the claimed topology projection accepted by the reservation. type: string topologyObservedAt: description: Time when the claimed topology projection was last observed. type: string format: date-time organizationScopedResourceReadMetadata: description: Metadata required by organization scoped resource reads. allOf: - $ref: '#/components/schemas/resourceReadMetadata' - type: object required: - organizationId properties: organizationId: description: The organization identifier the resource belongs to. type: string resourceReadMetadata: description: Metadata required by all resource reads. allOf: - $ref: '#/components/schemas/staticResourceMetadata' - type: object required: - provisioningStatus - healthStatus properties: deletionTime: description: The time the resource was deleted. type: string format: date-time provisioningStatus: $ref: '#/components/schemas/resourceProvisioningStatus' healthStatus: $ref: '#/components/schemas/resourceHealthStatus' staticResourceMetadata: description: | This metadata is for resources that just exist, and don't require any provisioning and health status, but benefit from a standardized metadata format. type: object allOf: - $ref: '#/components/schemas/resourceMetadata' - type: object required: - id - creationTime properties: id: description: The unique resource ID. type: string creationTime: description: The time the resource was created. type: string format: date-time createdBy: description: The user who created the resource. type: string modifiedTime: description: The time a resource was updated. type: string format: date-time modifiedBy: description: The user who updated the resource. type: string resourceProvisioningStatus: description: The provisioning state of a resource. type: string enum: - unknown - pending - provisioning - provisioned - deprovisioning - error resourceHealthStatus: description: The health state of a resource. type: string enum: - unknown - healthy - degraded - error resourceMetadata: description: Metadata required for all API resource reads and writes. required: - name properties: name: $ref: '#/components/schemas/kubernetesLabelValue' description: description: >- The resource description, this optionally augments the name with more context. type: string tags: $ref: '#/components/schemas/tagList' kubernetesLabelValue: description: >- A valid Kubernetes label value, typically used for resource names that can be indexed in the database. type: string pattern: ^[0-9A-Za-z](?:[0-9A-Za-z-_.]{0,61}[0-9A-Za-z])?$ tagList: description: A list of tags. type: array items: $ref: '#/components/schemas/tag' tag: description: >- A tag mapping arbitrary names to values. These have no special meaning for any component are are intended for use by end users to add additional context to a resource, for example to categorize it. type: object required: - name - value properties: name: description: A unique tag name. type: string value: description: The value of the tag. type: string securitySchemes: oauth2Authentication: type: oauth2 flows: authorizationCode: authorizationUrl: /oauth2/v2/authorization tokenUrl: /oauth2/v2/token scopes: {} ````