Skip to content
osctrlosctrlosctrl

osctrl-api

osctrl-api between the frontend, CLI and MCP bridge and the backend

The osctrl-api component of osctrl provides an API interface to interact with its enrolled nodes and with osctrl itself.

You can find the updated API documentation for osctrl, generated using Starlight OpenAPI.

It also exposes two newer operator-facing surfaces when enabled:

  • /api/v1/events streams best-effort Server-Sent Events hints for live frontend updates. The stream does not replace REST snapshots; clients still refetch the affected data after resource.changed.
  • /api/v1/mcp hosts the authenticated MCP endpoint when mcp.enabled is true, using the caller’s normal token, permissions and audit trail.