Host endpoints
Minimum role: manager (GET /host/info is also readable via the info-path rule).
| Method | Path | Role | Description |
|---|---|---|---|
| GET | /host/info | default | Host details |
| POST | /host/reboot | manager | Reboot the host |
| POST | /host/shutdown | manager | Power off the host |
| POST | /host/reload | manager | Re-read host state |
| POST | /host/options | manager | Change host settings |
| GET | /host/services | manager | List systemd services |
| GET | /host/disks/default/usage | manager | Storage usage breakdown |
| GET | /host/logs | manager | Full system journal (text/plain) |
| GET | /host/logs/follow | manager | Streamed journal |
| GET | /host/logs/identifiers | manager | Available syslog identifiers |
| GET | /host/logs/identifiers/{identifier} | manager | Logs for one identifier |
| GET | /host/logs/identifiers/{identifier}/follow | manager | Streamed logs for one identifier |
| GET | /host/logs/boots | manager | Boot ID list |
| GET | /host/logs/boots/{bootid} | manager | Logs for a boot |
| GET | /host/logs/boots/{bootid}/follow | manager | Streamed logs for a boot |
| GET | /host/logs/boots/{bootid}/identifiers/{identifier} | manager | Logs for identifier within a boot |
| GET | /host/logs/boots/{bootid}/identifiers/{identifier}/follow | manager | Streamed variant |
GET /host/info
Response data keys: agent_version, apparmor_version, chassis, virtualization, cpe, deployment, disk_free, disk_total, disk_used, disk_life_time, features, hostname, llmnr_hostname, kernel, operating_system, timezone, dt_utc, dt_synchronized, use_ntp, startup_time, boot_timestamp, broadcast_llmnr, broadcast_mdns.
POST /host/reboot, POST /host/shutdown
| Field | Type | Default | Description |
|---|---|---|---|
force | boolean | false | Proceed even while a Core offline database migration is running |
POST /host/options
| Field | Type |
|---|---|
hostname | string |
GET /host/services
Response data: services — list of name, description, state.
GET /host/disks/default/usage
Query parameter max_depth (int, default 1) controls directory-size recursion. Response data: id, label, total_bytes, used_bytes, and children — a system entry plus per-area sizes for app data, app configs, media, share, backup, ssl, and the Core config directory.
Log endpoints
{bootid}accepts a journal boot ID or a signed offset (0= current boot, negative values count backwards).- Query options:
lines(default 100),verbose,no_colors;Accept: text/x-logselects the verbose formatter; aRange: entries=cursor[[:num_skip]:num_entries]header allows cursor paging. TheX-First-Cursorresponse header carries the first line's cursor. - Streaming (
/follow) responses are unbuffered (X-Accel-Buffering: no).