Get Proxmox status

GET/api/proxmox/status

Reads the version, cluster, nodes, guests and storage of one Proxmox VE endpoint with its read-only token. When the endpoint cannot be read, the route answers 200 with status set to stale and the last reading, or unavailable and empty lists when there has been none.

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

Response

200 · application/json

The reading and how current it is.

versionobjectrequired

The Proxmox VE version.

clusterobject[]required

The cluster and its nodes.

resourcesobjectrequired

Everything Proxmox lists as a resource.

failed_collectorsstring[]

The reads that failed in this reading.

failure_classesobject

The failure class of each failed read.

warningsstring[]

Problems that did not stop the reading.

statusstringrequired

current is a full reading taken now. partially_readable means some reads failed. stale is the last good reading, shown because a new one failed. unavailable means no reading has worked.

Available options: currentpartially_readablestaleunavailable

updated_atstring<date-time>

When the readings were taken. Absent when status is unavailable.

failure_classstring

Why a read failed.

Available options: configurationresponsetlsauthenticationauthorizationtransport

messagestring

A sentence about the failure, when there is no class.

refresh_failed_collectorsstring[]

The reads that failed when a stale reading was refreshed.

refresh_failure_classesobject

The failure class of each read in refresh_failed_collectors.

cURLcURLPythonJavaScript

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

{
  "version": {
    "version": "",
    "release": ""
  },
  "cluster": [],
  "resources": {
    "nodes": [],
    "guests": [],
    "storage": []
  },
  "failed_collectors": [
    "version",
    "cluster",
    "resources"
  ],
  "failure_classes": {
    "cluster": "transport",
    "resources": "transport",
    "version": "transport"
  },
  "status": "unavailable",
  "failure_class": "transport"
}