List Proxmox guests

GET/api/proxmox/guests

Lists the virtual machines and containers on an endpoint. Use vmid, node and type from an entry in the guest action routes. The filters combine.

Authorizations

Authorizationstringheader

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.

Query parameters

endpointstring

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

Example: pve

nodestring

Return only guests on this node.

Example: pve

statusstring

Return only guests with this status, such as running or stopped.

Example: running

typestring

Return only guests of this type.

Available options: qemulxc

Response

200 · application/json

The matching guests.

vmidintegerrequired

The guest id.

nodestringrequired

The node the guest runs on.

typestringrequired

The guest type.

Available options: qemulxc

statusstringrequired

The guest status, such as running or stopped.

templatebooleanrequired

true for a template.

namestring

The guest name.

cpunumber

CPU use as a fraction of the allocation.

max_cpunumber

The CPUs allocated.

meminteger

Memory used in bytes.

max_meminteger

Memory allocated in bytes.

diskinteger

Disk used in bytes.

max_diskinteger

Disk allocated in bytes.

net_ininteger

Network bytes received.

net_outinteger

Network bytes sent.

uptimeinteger

Seconds since the guest started.

lockstring

The lock held on the guest, such as backup.

poolstring

The resource pool.

tagsstring[]

The guest's tags.

cURLcURLPythonJavaScript

curl --request GET \
  --url 'http://localhost:8080/api/proxmox/guests?endpoint=pve&node=pve&status=running' \
  --header 'Authorization: Bearer <token>'

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