HTTP API

Reference the unstable HTTP interface used by Rugix Admin's frontend.

Rugix Admin exposes an HTTP API used by its web interface.

Error Responses

API failures use a JSON object with a machine-readable code and an operator-facing message:

{
  "error": {
    "code": "invalid-query",
    "message": "invalid query parameters: ..."
  }
}

When Rugix Ctrl exits unsuccessfully, the error may also contain its exit status and non-empty standard output or standard error. The web interface displays the relevant diagnostic instead of representing the failed resource as empty device state.

Operations

The current API provides these operation families:

• GET /api/health reports whether the service is ready to accept requests.
• GET /api/info reports the Rugix Admin build version shown by the frontend.
• GET /api/daemon, /api/system/info, /api/components, /api/apps, and /api/apps/:app query the current device and daemon policy.
• POST /api/system/update/:job-id and POST /api/system/update/:job-id/url install uploaded and remote system bundles.
• POST /api/apps/install/:job-id and POST /api/apps/install/:job-id/url install uploaded and remote application bundles.
• POST /api/system/actions/:action, POST /api/apps/:app/actions/:action, and POST /api/apps/actions/gc start daemon-authorized lifecycle operations.
• GET /api/jobs, /api/jobs/:job-id, and /api/jobs/:job-id/events expose in-memory job status, output, progress, compatibility-bypass notices, and activation outcomes.
• GET /api/events exposes service-wide server-sent events. It emits an invalidate-all event whenever a job reaches succeeded or failed, so clients can refetch device information that the operation may have changed.

Installations and lifecycle actions return a job. Subscribe to the job’s event stream to follow it until its status becomes succeeded or failed. Each job event has a monotonically increasing SSE event ID. A reconnecting client can send Last-Event-ID; the service then replays only newer buffered events.

Jobs and buffered events are held in memory and are cleared when Rugix Admin restarts.