Skip to main content
GET
Get VM status by vmid

Authorizations

Authorization
string
header
required

Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh. A session satisfies every API scope.

Path Parameters

id
string<uuid>
required

Service id of the cloud server.

vmid
integer
required

The server's own Proxmox vmid. Any other number is answered 404.

Response

Current VM status as reported by Proxmox (status/current, plus node and vmid).

success
boolean
required
data
object
required

The VM as Proxmox reports it. Values are passed through from the hypervisor.