Skip to main content
Version: v5.6.1

Overview snapshot

Included from Basic tier

The aggregated fleet snapshot behind GET /api/admin/overview (admin token): one read replacing the Overview screen's fan-out over runners + groups + N×demand + queue + agents + posture + licence + maintenance. Every number is computed from the same sources the individual endpoints serve, in one pass per source.

The v2 OpenAPI document declares this resource's schema; the resource-field coverage gate holds this page to it.

Top-level fields​

FieldTypeMeaning
serverobjectThe replica's own status — exactly the GET /api/admin/status payload (shared builder); see the admin_status resource page. Per-replica facts (started_at, quiesce) describe the replica answering this request.
groupsarrayOne row per runner group — stored rows plus any group name runners carry without a stored row, so no member is invisible. Always present ([] when none). Fields below.
agentsobjectAgent-plane counts: online (not stopped, polled within the 3-minute liveness window), total (registered, unrevoked), halted (per-member emergency halt in force).
queueobjecttotal (every queue entry, leased included) and unsatisfiable (unleased entries blocked by a runner-plane halt, licence work-stop or this replica's quiesce, or failing the placement verdict). As coded, this count does not consult the system-quiesce posture — the per-entry fleet-queue view does.
postureobject{"runners": ..., "agents": ...} — each plane's active emergency posture, or null when the plane is normal. Posture fields below.
licence_statestringThe resolved licence lifecycle state: valid, in_grace or expired (see the licence_status resource page). Empty string when no entitlement service is wired or resolution failed.
maintenance_activeintCount of currently active maintenance windows (at most one per quiesced node). 0 when the server runs without a PostgreSQL pool or the read failed.

groups entries​

FieldTypeMeaning
namestringThe group name.
descriptionstringFrom the stored row. Absent when empty or no row exists.
exclusiveboolThe stored row's exclusive flag. Absent when false.
attributesstring mapThe stored row's placement attributes. Absent when empty.
bindingsstring arrayThe stored row's node-path bindings. Absent when empty.
drain_requested_attimestampA group-wide drain is in force. Absent when not draining.
members_onlineintMember runners not stopped and polled within the 3-minute liveness window.
members_totalintRegistered member runners.
queuedintUnleased queue entries this group's placement posture could take (same rule as the per-group demand endpoint).
runningintLive job bindings held by the group's members.

Posture fields (posture.runners / posture.agents)​

The active EmergencyPosture row, or null:

FieldTypeMeaning
idstringThe posture's identity, quoted in dispatch verdicts.
planestringrunners or agents.
in_flightstringThe halt's declared treatment of in-flight work. Absent when empty.
reasonstringThe operator's stated reason.
halted_bystringWho applied the halt.
halted_attimestampWhen.
resumed_by / resumed_atstring / timestampSet once resumed — an active posture has resumed_at null/absent (resumption is what deactivates it; the overview only ever embeds active postures).

Where the values come from​

Runners, groups, agents and live jobs come from the fleet registry; queue entries from the scheduler's set-based inventory read; postures from the durable posture store; licence_state from the entitlement resolution; maintenance_active from the active-windows read. Degradations are partial, not fatal: a failed licence resolution leaves licence_state empty and a missing pool leaves maintenance_active 0, while a registry or scheduler read failure answers 500.

  • opschain docs fleet-queue — the per-entry view behind queue.
  • opschain docs platform-halt — the postures embedded here.
  • opschain docs entitlements — the licence state vocabulary.
  • opschain docs maintenance-windows — what an active window quiesces.