Sign in
rentals

Update a rental

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 body

rentalIdnumber required
labelstring
convertToOnDemandOnExpiryboolean

Response

Successful response

idinteger required
createdAtstring required
updatedAtstring nullable required
deletedAtstring nullable required
userIdstring required
orgIdstring nullable required
startedAtstring nullable required
terminatedAtstring nullable required
rentalIdstring required
rentalType'virtual-machine' | 'bare-metal' required
namestring nullable required
labelstring nullable 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' | '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' | 'us-east-3' | 'uk-central-3' | 'uk-southeast-3' | 'eu-southwest-3' | 'eu-southwest-3-1' | 'eu-west-3' | 'eu-west-4' | 'private-cloud' nullable required
convertToOnDemandOnExpiryboolean nullable required
managedK8sClusterIdinteger nullable required
gpuType'h100' | 'h200' | 'b200' | 'rtx-6000-pro' required
gpuCountinteger required

Changes

Changed in 6 of the 14 revisions of this API.4518

  • 119b1ecbb0b2311See the full diff
    • ▲

      the / response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      the response's property type changed from no type to string for status

      response-property-type-changed

    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ○

      removed the mock-region enum value from the / response property for the response status

      response-property-enum-value-removed

  • 258ebb032c4a1See the full diff
    • ●

      added the new eu-west-5 enum value to the / response property for the response status

      response-property-enum-value-added

  • 1875a16896e111See the full diff
    • ●

      added the new us-southeast-3 enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      api tag rentals added

      api-tag-added

  • 35ac283ae04f15See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 subschema #11 from the response property oneOf list for the response status

      response-property-one-of-removed

    • ○

      added the required property / to the response with the status

      response-required-property-added

  • e16451dac63412See the full diff
    • ▲

      added subschema #9 to the response property oneOf list for the response status

      response-property-one-of-added

    • ●

      added the new rtx-6000-pro enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new us-east-3 enum value to the / response property for the response status

      response-property-enum-value-added

  • c5ba6c2504bb1See the full diff
    • ○

      endpoint added

      endpoint-added