List open ports

GET/api/ports

Lists the TCP ports listening on the machine, with the process or Docker container that owns each one. With server, the route returns the array that homebutler ports --json prints on that server, without the ports wrapper. When the ports cannot be listed, the route returns 500 with the reason.

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 listening ports. The example is shortened.

portsobject[]required

The listening ports.

missing_processboolean

true when the process behind some ports could not be read.

cURLcURLPythonJavaScript

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

{
  "ports": [
    {
      "protocol": "tcp",
      "address": "127.0.0.1",
      "port": "53"
    },
    {
      "protocol": "tcp",
      "address": "0.0.0.0",
      "port": "18611",
      "container": "gitea (imgproxy:1)"
    },
    {
      "protocol": "tcp",
      "address": "0.0.0.0",
      "port": "18610",
      "container": "web (node:lts-alpine)"
    },
    {
      "protocol": "tcp",
      "address": "192.168.5.1",
      "port": "53"
    },
    {
      "protocol": "tcp",
      "address": "127.0.0.1",
      "port": "18600",
      "pid": "459588",
      "process": "homebutler"
    },
    {
      "protocol": "tcp",
      "address": "127.0.0.1",
      "port": "18602",
      "pid": "459604",
      "process": "homebutler"
    },
    {
      "protocol": "tcp",
      "address": "0.0.0.0",
      "port": "22"
    },
    {
      "protocol": "tcp",
      "address": "[::1]",
      "port": "53"
    },
    {
      "protocol": "tcp",
      "address": "*",
      "port": "18601"
    },
    {
      "protocol": "tcp",
      "address": "[::]",
      "port": "18611",
      "container": "gitea (imgproxy:1)"
    },
    {
      "protocol": "tcp",
      "address": "[::]",
      "port": "18610",
      "container": "web (node:lts-alpine)"
    },
    {
      "protocol": "tcp",
      "address": "[fe80::5055:55ff:fe23:93b6]%eth0",
      "port": "53"
    },
    {
      "protocol": "tcp",
      "address": "[::]",
      "port": "22"
    }
  ],
  "missing_process": true
}