Skip to main content
Each orun node exposes a lightweight HTTP API on port 9100 (configurable via --status-port) that lets you inspect node health and the current state of all deployments and services. The server binds to localhost only — to query it from a remote machine, open an SSH tunnel first.
The status API is read-only and makes no changes to containers or configuration. It reads exclusively from the in-memory state store maintained by the agent.

​
Accessing the API remotely

Because the API listens on localhost, use an SSH tunnel to reach it from outside the node: 
ssh -L 9100:localhost:9100 root@<host>
Then query the API locally as if you were on the node.

​
POST /healthz

Returns a simple liveness response. Use this endpoint to confirm the orun agent process is running and able to accept requests. Request: no body required. Response: 
{"status": "ok"}
​
status
string
required
Always "ok" when the agent is alive. If the agent is not running, the connection will be refused rather than returning an error body.
curl -X POST http://localhost:9100/healthz

​
POST /status

Returns the full NodeReport — a consistent, point-in-time snapshot of the node, all tracked deployments, and all active ingress routes. Request: no body required. Response: a NodeReport object.
​
node
object
required
Node-level status information.
​
deployments
object
required
A map of deployment name to deployment status. Each key is the deployment’s metadata name from its manifest.
​
services
object
required
A map of service name to service status. Each key is the service’s metadata name from its manifest.

​
Example request and response

curl -X POST http://localhost:9100/status

{
  "node": {
    "name": "web-01",
    "started_at": "2024-11-01T10:00:00Z",
    "last_sync_time": "2024-11-01T10:00:05Z",
    "git_head": "a1b2c3d4e5f6...",
    "sync_error": null
  },
  "deployments": {
    "hello-world": {
      "name": "hello-world",
      "image": "traefik/whoami",
      "container_id": "4a7f9b2e1c3d",
      "state": "running",
      "changed_at": "2024-11-01T10:00:06Z"
    }
  },
  "services": {
    "hello-world": {
      "name": "hello-world",
      "deployment": "hello-world",
      "domain": "hello-world.example.com",
      "route_active": true
    }
  }
}
orun is pre-release software. The structure of the NodeReport response may change in future versions without a deprecation period.