HYhyperbolic
rentals

Update a rental

Changed on

Update a rental's label and/or its reserved-term end-of-term action. Pass an empty label to clear it.

post/v2/on-demand/rentals/update

Request

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

Request body

labelstring
convertToOnDemandOnExpiryboolean

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

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

  • 194666d30bfcRevision changes
    • warning

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

  • 6d718ca26d2bRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      response property convertToOnDemandOnExpiry list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property createdBy/name list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property createdBy/picture list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property label list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property managedCluster/anyOf[ManagedClusterRef]/label list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property name list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property nodes/items/cpuCount list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property nodes/items/vcpuCount list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property orgId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property privateCluster/anyOf[PrivateCluster]/gpuModel list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property privateCluster/anyOf[PrivateCluster]/location list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property privateCluster/anyOf[PrivateCluster]/nodes/items/hostname list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property privateCluster/anyOf[PrivateCluster]/nodes/items/publicIp list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property privateCluster/anyOf[PrivateCluster]/sshPort list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property terminationReason list-of-types was narrowed by removing types null from media type application/json of response 200