API ReferenceCloud Vms

Start a cloud VM

Starts a stopped cloud VM. Requires scope: vm.write.

Authentication

AuthorizationBearer

IBEE platform API token, for example: ibee_live_xxx.

Path parameters

vm_idstringRequired
Virtual machine ID.

Headers

X-Idempotency-KeystringRequired
Unique key used to safely retry write operations.

Query parameters

workspace_idstringRequired
The workspace ID to scope this request to.

Request

This endpoint expects an object.
forcebooleanOptionalDefaults to false
Force the action even if the VM is in a transitional state.

Response

VM start accepted.
operation_idstring
vm_idstring
statusstring
submitted_atdatetime

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error