Skip to main content
PATCH
/
vm
/
{vm_id}
/
state
cURL
curl --request PATCH \
  --url https://api.example.com/vm/{vm_id}/state \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": "Paused"
}
'
{
  "error": "<string>",
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
vm_id
string<uuid>
required

VM ID

Query Parameters

​
skip_wait_boot
boolean

If true, error immediately if the VM is not finished booting. Defaults to false

Body

application/json

Request body for PATCH /api/vm/{vm_id}/state

​
state
enum<string>
required

The requested state for the VM

Available options:
Paused,
Running

Response

VM state updated successfully