Skip to main content

Virtual Machine Operations

Perform various operations on virtual machines (start, stop, restart, etc.).

Start Virtual Machine​

Request​

POST /api/v1/pve/vm/:clusterId/:node/:vmid/start
Authorization: Bearer <token>

Path Parameters​

ParameterTypeDescription
clusterIdintCluster ID
nodestringNode name
vmidintVirtual machine ID

Response​

{
  "code": 200,
  "message": "success"
}

Stop Virtual Machine​

Request​

POST /api/v1/pve/vm/:clusterId/:node/:vmid/stop
Authorization: Bearer <token>

Response​

{
  "code": 200,
  "message": "success"
}

Restart Virtual Machine​

Request​

POST /api/v1/pve/vm/:clusterId/:node/:vmid/reboot
Authorization: Bearer <token>

Response​

{
  "code": 200,
  "message": "success"
}

Force Stop​

Request​

POST /api/v1/pve/vm/:clusterId/:node/:vmid/stop?force=true
Authorization: Bearer <token>