API ReferenceGpu Vms

Precheck a GPU VM resize

Evaluates a requested CPU, memory, or root-disk change before starting it. Requires scope: vm.write.

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

vm_idstringRequired
Virtual machine ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Request

This endpoint expects an object.
cpuintegerOptional1-256
ram_mbintegerOptional257-2097152
disk_gbintegerOptional1-10000
requested_bystringOptionalDefaults to api

Response

Resize decision returned successfully.
decisionenum
reasonslist of strings
warningslist of strings
migration_checklistlist of strings
migration_stepslist of strings
requires_stopboolean
downtime_expectedboolean
no_changesboolean
current_statestring
currentobject
targetobject
modeenum or nullOptional
live_statestring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error