rentals

Update a rental

Deprecated. This path is the pre-/v2/ URL for /v2/on-demand/rentals/update and is kept only so existing integrations keep working. It behaves identically, responds with a Sunset header, and stops being served on 2027-03-01. Move to /v2/on-demand/rentals/update.

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

post/v2/alpha/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

convertToOnDemandOnExpiryboolean nullable required

managedK8sClusterIdinteger nullable required

gpuType'h100' | 'h200' | 'b200' | 'rtx-6000-pro' required

gpuCountinteger required

Changes

Changed in 7 of the 14 revisions of this API.5621

Sep 22, 2026119b1ecbb0b2311See 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
Sep 17, 2026258ebb032c4a1See the full diff
- ●
  added the new eu-west-5 enum value to the / response property for the response status
  response-property-enum-value-added
Sep 16, 20261875a16896e111See 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
Sep 15, 202635ac283ae04f15See 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
Sep 8, 2026e16451dac63412See 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
Sep 3, 2026c5ba6c2504bb2See the full diff
- ○
  api operation id ondemand-updateRental removed and replaced with ondemand-updateRental-legacy
  api-operation-id-removed
- ○
  endpoint deprecated
  endpoint-deprecated
Aug 28, 20266831853d7362112See the full diff
- ▲
  added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 to the response property oneOf list for the response status
  response-property-one-of-added
- ●
  added the new ca-east-3 enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 subschema #10 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

Full history