Get container stats

GET/api/docker/stats

Returns a one-shot CPU, memory, network and disk reading for each running container. Values are the strings Docker prints, such as 0.00% and 10.96MiB / 7.755GiB.

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

serverstring

The name of a remote server from List servers. homebutler runs the command on it over SSH and returns its answer. Leave it out, name the local server, or name a server that is not in the config, to read this machine.

Example: nas

Response

200 · application/json

The readings, or available: false when Docker is not reachable. The example is shortened.

availablebooleanrequired

false when Docker did not answer.

messagestring

Why Docker is unavailable. Present only when available is false.

statsobject[]required

One reading per running container. Empty when Docker is unavailable.

cURLcURLPythonJavaScript

curl --request GET \
  --url 'http://localhost:8080/api/docker/stats?server=nas' \
  --header 'Authorization: Bearer <token>'

{
  "available": true,
  "stats": [
    {
      "id": "986579b4a954",
      "name": "romantic_zhukovsky",
      "cpu_percent": "0.00%",
      "mem_usage": "116KiB / 7.755GiB",
      "mem_percent": "0.00%",
      "net_io": "2.95kB / 126B",
      "block_io": "0B / 4.1kB",
      "pids": "0"
    },
    {
      "id": "3bf9c444b8db",
      "name": "web",
      "cpu_percent": "0.00%",
      "mem_usage": "10.93MiB / 7.755GiB",
      "mem_percent": "0.14%",
      "net_io": "1.36kB / 126B",
      "block_io": "0B / 0B",
      "pids": "7"
    },
    {
      "id": "a022d81b0f81",
      "name": "hook",
      "cpu_percent": "0.00%",
      "mem_usage": "11.75MiB / 7.755GiB",
      "mem_percent": "0.15%",
      "net_io": "0B / 0B",
      "block_io": "81.9kB / 0B",
      "pids": "7"
    },
    {
      "id": "f32260339376",
      "name": "gitea",
      "cpu_percent": "0.00%",
      "mem_usage": "11.61MiB / 7.755GiB",
      "mem_percent": "0.15%",
      "net_io": "2.24kB / 606B",
      "block_io": "0B / 0B",
      "pids": "7"
    }
  ]
}