---
title: "List past rentals"
method: GET
path: "/v2/on-demand/rentals/history"
tags: ["rentals"]
---

# List past rentals

`GET /v2/on-demand/rentals/history`

## Request

- Base URL: `https://api.hyperbolic.ai`
- URL: `https://api.hyperbolic.ai/v2/on-demand/rentals/history`
- Auth: HTTP bearer

Past rentals, most recently terminated first, one page at a time. Pass the response's `nextCursor` as `cursor` to read the next page.

## Query parameters

- `cursor` string, nullable
- `limit` integer
- `gpuType` 'h100' | 'h200' | 'b200' | 'rtx-6000-pro'
- `region` 'us-central-1' | 'us-central-2' | 'eu-north-2' | 'eu-west-2' | 'eu-north-4' | 'eu-north-5' | 'us-east-1' | 'us-east-2' | 'ca-east-3' | 'eu-north-6' | 'eu-north-7' | 'eu-north-8' | 'eu-north-9' | 'ca-west-1' | 'ca-east-1' | 'us-central-3' | 'us-southeast-1' | 'me-central-1' | 'ca-east-2' | 'eu-west-1' | 'us-southeast-2' | 'jp-east-1' | 'us-southeast-3' | 'eu-west-5' | 'jp-east-2' | 'us-east-3' | 'uk-central-3' | 'uk-southeast-3' | 'eu-southwest-3' | 'eu-southwest-3-1' | 'eu-west-3' | 'eu-west-4' | 'private-cloud'
- `termType` 'on-demand' | 'reserved' | 'private-cloud'
- `includePrivateCloud` boolean: Include private-cloud rentals. Ignored when `termType` is set.
- `rentalType` 'virtual-machine' | 'bare-metal'

## Response `200`

Successful response

- RentalHistoryPage: One page of past rentals, most recently terminated first. Pass `nextCursor` back as `cursor` for the next page; it is `null` on the last page. `totalCount` is set on the first page only.
  - `items` HistoricalRental[], required
    - `rentalId` string, required
    - `name` string, nullable, required
    - `label` string, nullable, required
    - `rentalType` 'virtual-machine' | 'bare-metal', required
    - `region` 'us-central-1' | 'us-central-2' | 'eu-north-2' | 'eu-west-2' | 'eu-north-4' | 'eu-north-5' | 'us-east-1' | 'us-east-2' | 'ca-east-3' | 'eu-north-6' | 'eu-north-7' | 'eu-north-8' | 'eu-north-9' | 'ca-west-1' | 'ca-east-1' | 'us-central-3' | 'us-southeast-1' | 'me-central-1' | 'ca-east-2' | 'eu-west-1' | 'us-southeast-2' | 'jp-east-1' | 'us-southeast-3' | 'eu-west-5' | 'jp-east-2' | 'us-east-3' | 'uk-central-3' | 'uk-southeast-3' | 'eu-southwest-3' | 'eu-southwest-3-1' | 'eu-west-3' | 'eu-west-4' | 'private-cloud', required
    - `gpuType` 'h100' | 'h200' | 'b200' | 'rtx-6000-pro', required
    - `gpuCount` integer, required
    - `gpuFormFactor` 'sxm5' | 'sxm6' | 'pcie', required
    - `connectionType` 'infiniband' | 'ethernet', required
    - `ethernetVariant` 'normal' | 'rocev2', nullable, required
    - `nodes` RentalNode[], required
      - `cpuModel` string, required
      - `cpuCount` number, nullable, required
      - `vcpuCount` number, nullable, required
      - `gpuCount` number, required
      - `ramGb` number, required
      - `storageGb` number, required
    - `sshEndpoints` SshEndpoint[], required
      - `host` string, required
      - `port` number, required
      - `user` string, required
    - `networkInterfaces` NetworkInterface[], required
      - `publicIp` string, required
      - `privateIp` string, required
    - `portMappings` PortMapping[], required
      - `externalPort` number, required
      - `internalPort` number, required
    - `supportsPortForwarding` boolean, required
    - `exposedPorts` number[], required
    - `supportsCustomPorts` boolean, required
    - `supportsMultipleSshKeys` boolean, required
    - `supportsSshKeyUpdates` boolean, required
    - `attachedStorage` AttachedStorage[], required
      - `storageVolumeId` string, required
      - `label` string, required
      - `sizeInGb` integer, required
      - `virtualIp` string, required
      - `costPerHourCents` number, required
    - `supportsAttachedStorage` boolean, required
    - `monitoringEnabled` boolean, required
    - `convertToOnDemandOnExpiry` boolean, nullable, required
    - `terminationReason` string, nullable, required
    - `currentTerm` union, required
      - object
        - `effectiveAt` string, date-time, required
        - `termType` 'on-demand', required
        - `costPerHour` number, required
        - `reservedUntil` unknown, required
        - `reservationEndsAt` unknown, required
        - `termPeriodDays` unknown, required
        - `discountPercentage` unknown, required
        - `originalCostPerHour` unknown, required
      - object
        - `effectiveAt` string, date-time, required
        - `termType` 'reserved', required
        - `costPerHour` number, required
        - `reservedUntil` string, date-time, nullable, required
        - `reservationEndsAt` string, date-time, nullable, required
        - `termPeriodDays` number, required
        - `discountPercentage` number, required
        - `originalCostPerHour` number, required
      - object
        - `effectiveAt` string, date-time, required
        - `termType` 'private-cloud', required
        - `costPerHour` number, required
        - `reservedUntil` unknown, required
        - `reservationEndsAt` unknown, required
        - `termPeriodDays` unknown, required
        - `discountPercentage` unknown, required
        - `originalCostPerHour` unknown, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, nullable, required
    - `startedAt` string, date-time, nullable, required
    - `terminatedAt` string, date-time, required
    - `userId` string, required
    - `orgId` string, nullable, required
    - `createdBy` RentalCreator, required: The user who created a rental.
      - `id` string, required
      - `name` string, nullable, required
      - `email` string, required
      - `picture` string, nullable, required
    - `privateCluster` PrivateCluster, required: The topology of a dedicated private cluster.
      - `gpuModel` string, nullable, required
      - `location` string, nullable, required
      - `sshUser` string, required
      - `sshPort` number, nullable, required
      - `nodes` PrivateClusterNode[], required
        - `role` 'login' | 'head' | 'compute', required
        - `hostname` string, nullable, required
        - `publicIp` string, nullable, required
        - `privateIp` string, required
      - `handover` object, required
    - `managedCluster` ManagedClusterRef, required: The managed Kubernetes cluster a rental is a node pool of.
      - `name` string, required
      - `label` string, nullable, required
    - `status` 'Terminated' | 'Failed', required
    - `totalCost` number, required
  - `nextCursor` string, nullable, required
  - `totalCount` integer, nullable, required

## Other responses

- `400`: Invalid input data
- `401`: Authorization not provided
- `403`: Insufficient access
- `404`: Not found
- `500`: Internal server error

## Changes

- **2026-10-31** `194666d30bfc`: 1 warning, 1 info
  - added the new `jp-east-2` enum value to the `items/items/region` response property for the response status `200`
  - added the new enum value `jp-east-2` to the `query` request parameter `region`
- **2026-10-26** `6d718ca26d2b`: 16 breaking, 16 info
  - the response property `items/items/convertToOnDemandOnExpiry` became nullable for the status `200`
  - the response property `items/items/createdBy/name` became nullable for the status `200`
  - the response property `items/items/createdBy/picture` became nullable for the status `200`
  - the response property `items/items/label` became nullable for the status `200`
  - …28 more
- **2026-10-21** `ae69ee1b2989`: 2 info
  - added the required property `items/items/supportsMultipleSshKeys` to the response with the `200` status
  - added the required property `items/items/supportsSshKeyUpdates` to the response with the `200` status
- **2026-10-19** `b242fec51e36`: 1 warning, 1 info
  - added the new `eu-north-9` enum value to the `items/items/region` response property for the response status `200`
  - added the new enum value `eu-north-9` to the `query` request parameter `region`
- **2026-10-03** `6d05031524bd`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hyperbolic/apis/castle-api/changes/v2/on-demand/rentals/history/get.md)

---

[API](https://skmtc.dev/hyperbolic/apis/castle-api.md) - [All operations](https://skmtc.dev/hyperbolic/apis/castle-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hyperbolic/apis/castle-api/revisions/d4d4f25214b8?raw)