Start Proxmox guest

POST/api/proxmox/guests/{vmid}/start

Starts a guest with the endpoint's action token. Protection: token. Proxmox runs the start as a task, and the route returns once Proxmox accepts it, with the task id in upid. Without an action token on the endpoint the route answers 400: it never falls back to the read-only token.

Authorizations

Authorizationstringheaderrequired

The token you start the server with: homebutler serve --token <token>, or web.token in the config file. Send it as Authorization: Bearer <token>. When the server has a token, every /api/ route except the CORS preflight requires it, reads included.

Path parameters

vmidintegerrequired

The numeric guest id, from List Proxmox guests.

Example: 100

Query parameters

endpointstring

The name of a Proxmox endpoint from List Proxmox endpoints. Needed when more than one is configured.

Example: pve

Body

application/json

nodestringrequired

The node of the guest.

Example: pve

typestringrequired

The type of the guest.

Available options: qemulxc

Response

200 · application/json

Proxmox accepted the task.

actionstringrequired

What was asked.

Available options: startshutdownreboot

endpointstringrequired

The endpoint name.

nodestringrequired

The node.

typestringrequired

qemu or lxc.

vmidintegerrequired

The guest id.

statusstringrequired

accepted: Proxmox queued the task.

Available options: accepted

upidstringrequired

The Proxmox task id.

cURLcURLPythonJavaScript

curl --request POST \
  --url 'http://localhost:8080/api/proxmox/guests/{vmid}/start?endpoint=pve' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "node": "pve",
  "type": "qemu"
}'

No example captured. This response needs a condition the test server could not produce.