Sign in

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
{"stackTrail":"paths:/v2/on-demand/rentals/update:post:responses:200:content:application/json:schema:properties:orgId:anyOf","oasType":"schema","type":"unknown","nullable":true}
startedAtstring nullable required
terminatedAtstring nullable required
externalIdstring required
{"stackTrail":"paths:/v2/on-demand/rentals/update:post:responses:200:content:application/json:schema:properties:rentalId","oasType":"schema","type":"unknown"}
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' | 'mock-region' | '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' required
gpuCountinteger required

Changes

Changed in 1 of the 4 revisions of this API.1