List containers

GET/api/docker

Lists every Docker container on the machine, running or stopped. When Docker does not answer, the route still returns 200 with available set to false and an empty list.

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 containers, 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.

containersobject[]required

The containers. Empty when Docker is unavailable.

cURLcURLPythonJavaScript

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

{
  "available": true,
  "containers": [
    {
      "id": "986579b4a954",
      "name": "romantic_zhukovsky",
      "image": "alpine",
      "status": "Running · 4m",
      "state": "running",
      "ports": ""
    },
    {
      "id": "0063e741c1f9",
      "name": "whoami",
      "image": "node:lts-alpine",
      "status": "Stopped · 38s ago",
      "state": "exited",
      "ports": ""
    },
    {
      "id": "3bf9c444b8db",
      "name": "web",
      "image": "node:lts-alpine",
      "status": "Running · 51s",
      "state": "running",
      "ports": "0.0.0.0:8610->18610/tcp, [::]:8610->18610/tcp"
    },
    {
      "id": "a022d81b0f81",
      "name": "hook",
      "image": "node:lts-alpine",
      "status": "Running · 47m",
      "state": "running",
      "ports": ""
    },
    {
      "id": "f32260339376",
      "name": "gitea",
      "image": "imgproxy:1",
      "status": "Running · 45m",
      "state": "running",
      "ports": "18610/tcp, 0.0.0.0:8611->3000/tcp, [::]:8611->3000/tcp"
    }
  ]
}