Skip to content

POST /api/vms/{id}/resume

Updated

Resume paused VM vCPUs.

PropertyValue
Scopereadwrite
Request bodynone
Success204 No Content

Endpoint

POST ${baseUrl}/api/vms/${id}/resume
readwrite

Resume vCPUs for a paused VM.

Use your host URL and API key as shell variables:

baseUrl="https://agent.example.com"
VIRT_AGENT_API_KEY="<your-api-key>"

cURL template

curl --request POST "${baseUrl}/api/vms/${id}/resume" \
  --header "Authorization: Bearer ${VIRT_AGENT_API_KEY}"
LocationNameTypeRequiredDescription
HeaderAuthorizationbearer tokenyesBearer ${VIRT_AGENT_API_KEY} from a readwrite key.
PathidstringyesVM id.
StatusBodyDescription
204 No ContentnoneVM vCPUs were resumed. Read the VM afterward to confirm state.
Terminal window
baseUrl="https://agent.example.com"
VIRT_AGENT_API_KEY="<your-api-key>"
id="demo-api-vm"
curl --request POST "${baseUrl}/api/vms/${id}/resume" \
--header "Authorization: Bearer ${VIRT_AGENT_API_KEY}"
HTTP/1.1 204 No Content
StatusCodeDescription
401UNAUTHORIZEDAPI key is missing or invalid.
403FORBIDDENKey is read-only or endpoint is outside the key allowlist.
404NOT_FOUNDVM id does not exist.
409INVALID_STATEVM is not paused or cannot be resumed.
500CH_ERROR or INTERNALCloud Hypervisor resume failed.