HYhyperbolic
virtual-machine-rentals

Get a list of active virtual machine rentals

Changed on

Deprecated. Returns every active virtual machine rental in one response. Use GET /v2/on-demand/rentals/active?rentalType=virtual-machine, which returns them a page at a time.

get/v2/on-demand/virtual-machine-rentals

Request

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

Query parameters

includeClusterPoolsboolean

Response

Successful response

rentalIdstring required
namestring nullable required
labelstring 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
gpuCountinteger required
gpuFormFactor'sxm5' | 'sxm6' | 'pcie' required
connectionType'infiniband' | 'ethernet' required
ethernetVariant'normal' | 'rocev2' nullable required
supportsPortForwardingboolean required
exposedPortsnumber[] required
supportsCustomPortsboolean required
supportsMultipleSshKeysboolean required
supportsSshKeyUpdatesboolean required
supportsAttachedStorageboolean required
monitoringEnabledboolean required
convertToOnDemandOnExpiryboolean nullable required
terminationReasonstring nullable required
createdAtstring date-time required
updatedAtstring date-time nullable required
startedAtstring date-time nullable required
terminatedAtstring date-time nullable required
userIdstring required
orgIdstring nullable required
status'Failed' | 'Pending' | 'Rebooting' | 'Running' | 'Terminating' | 'Terminated' | 'Unknown' required
monitoringOptOutboolean nullable required

Whether the rental is opted out of Hyperbolic telemetry. Null where the rental can't opt out, or its setting couldn't be read.

Example response

[
  {
    "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