API Documentation
The API Docs page embeds the live Swagger user interface for the console REST API. It lists every endpoint available in the running version and lets you test each one with your current login session. You can also download the OpenAPI specification.
Use the Swagger UI
- Expand an endpoint — click an endpoint row to see its parameters, request body schema, response schema, and example values.
- Try it out — on an expanded endpoint, click Try it out, fill in the parameters, and click Execute. Swagger sends the real request to the console and shows the live response.
- Authorization — the API uses session-cookie authentication. While you are logged in, Swagger requests are authenticated automatically. You do not need an API key to test in the interface.
warning
Requests sent from the Swagger UI act on the live console. Take care when you test write endpoints (POST, PATCH, and DELETE) on a production system.
Download the API Specification
Click Download API Spec (JSON) to save the full OpenAPI 3.0 specification as argusk8-api.json. The specification always reflects the version that is currently deployed. Use it to:
- Generate client SDKs in any language with OpenAPI Generator.
- Import the API into Postman or Insomnia for testing.
- Feed contract tests in a CI pipeline.
Open in New Tab
Click Open in New Tab to open the Swagger UI in a full browser tab. It gives you more room for complex schemas and response bodies.
Key API Areas
| Path | Purpose |
|---|---|
/api/audit-query | Search and filter audit events |
/api/agents | Agent registry: register, drain, update, crash timeout |
/api/settings | Read and write system settings |
/api/license | Install, remove, and generate product license keys |
/api/jobs | Query job history, cancel and resume jobs |
/api/auth | Log in, log out, and manage sessions |