SQL Cockpit API Reference
An overview of the implemented SQL Cockpit Agent control-plane API. A complete public API specification is not yet published.
SQL Cockpit Agent control plane
Implemented backend · partial reference
The available reference covers Agent communication with the cloud portal. It does not document a general database migration or query API. No public OpenAPI specification or interactive playground is published here.
Authentication
Implementation overview
The routes below use device bearer tokens. Registration and signed Agent routes use separate authentication flows; they are not interchangeable with bearer tokens. Availability depends on the deployed portal version and tenant configuration.
Documented Agent routes
Implemented and documented
POST /api/agent/heartbeat — report device status. GET /api/agent/commands/next — fetch queued work; returns 204 when none is available. POST /api/agent/commands/{command}/started — acknowledge a command. POST /api/agent/commands/{command}/result — report its result. POST /api/agent/telemetry — submit telemetry. Commands must belong to the authenticated device. These routes are verified against backend/routes/api.php and backend/docs/device-control-plane-api.md; this overview is not a complete request/response contract.
Integration guidance
Full reference coming
Contact the team for deployment-specific integration guidance. Complete payload schemas, error contracts and versioning guidance are not published on this page.