Get server usage

The server's CPU, memory and disk usage.

GET/api/v1/system

Returns the server's current CPU, memory and disk usage. Works with a viewer or an admin token.

Authorizations

bearerAuthbearer
An API token created in Settings → API tokens. Tokens start with qsr_.

Request

curl -X GET 'https://admin.your-domain.com/api/v1/system' \
  -H 'Authorization: Bearer $TOKEN'

Responses

200

200Current usage.

cpu_percentnumberrequired
mem_percentnumberrequired
mem_used_gbnumberrequired
mem_total_gbnumberrequired
disk_percentnumberrequired
disk_used_gbnumberrequired
disk_total_gbnumberrequired

Response

{
  "cpu_percent": 12.5,
  "mem_percent": 41.2,
  "mem_used_gb": 1.6,
  "mem_total_gb": 3.8,
  "disk_percent": 57,
  "disk_used_gb": 22.1,
  "disk_total_gb": 38.7
}

401

401The token is missing or invalid.

errorstringrequired
What went wrong.

Response

{
  "error": "invalid token"
}

500

500Usage could not be read.

errorstringrequired
What went wrong.

Response

{
  "error": "string"
}