HYhyperbolic
rentals

List active rentals

Changed on

Active rentals with their live status, most recently started first, as numbered pages. Pass rentalType to list one machine type; omit it to list all of them.

get/v2/on-demand/rentals/active

Request

  • Base URL
    https://api.hyperbolic.ai
  • Auth
    HTTP bearer

Query parameters

pageinteger
pageSizeinteger
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'
includePrivateCloudboolean

Include private-cloud rentals. Ignored when termType is set.

rentalType'virtual-machine' | 'bare-metal'
includeClusterPoolsboolean

Also list the node pools of managed Kubernetes clusters. They cannot be terminated or rebooted individually; manage them through the cluster.

Response

Successful response

totalinteger required
pageinteger required
pageSizeinteger required
totalPagesinteger required

Example response

{
  "items": [
    {
      "currentTerm": {
        "effectiveAt": "2025-01-31T12:00:00.000Z"
      },
      "createdAt": "2025-01-31T12:00:00.000Z",
      "updatedAt": "2025-01-31T12:00:00.000Z",
      "startedAt": "2025-01-31T12:00:00.000Z",
      "terminatedAt": "2025-01-31T12:00:00.000Z"
    }
  ]
}

Changes

  • 194666d30bfcRevision changes
    • warning

      added the new jp-east-2 enum value to the // response property for the response status

    • info

      added the new enum value jp-east-2 to the query request parameter region

  • dbf29b4ec8eaRevision changes
    • info

      added the required property // to the response with the status