List top processes

GET/api/processes

Returns the ten processes using the most CPU, busiest first. Without server, the route returns the list itself, without the total and zombies fields the MCP tool adds. With server, it returns the document that homebutler processes --json prints on that server, an object with a processes array and total.

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 ten busiest processes. The example is shortened.

pidintegerrequired

Process id.

namestringrequired

Process name.

cpunumberrequired

CPU use in percent.

memnumberrequired

Memory use in percent.

rssintegerrequired

Resident memory in KB.

statestring

Process state letter, such as R or S.

zombieboolean

true for a zombie process.

cURLcURLPythonJavaScript

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

[
  {
    "pid": 1731,
    "name": "containerd",
    "cpu": 9.7,
    "mem": 0.7,
    "rss": 62144,
    "state": "S"
  },
  {
    "pid": 1888,
    "name": "dockerd",
    "cpu": 4.7,
    "mem": 1.2,
    "rss": 99540,
    "state": "S"
  },
  {
    "pid": 460000,
    "name": "sh",
    "cpu": 4.5,
    "mem": 0,
    "rss": 1144,
    "state": "S"
  }
]