Skip to main content
Migration Notice
We're migrating documentation from the old portal into this one. Some things may look a little different or out of place in the meantime — we know, and we're working to get it right. If something's unclear or doesn't look right, let us know.

API Documentation

Overview​

The API Docs page embeds the live Swagger user interface for the console's backend REST API. Every endpoint available in the running build is listed and testable directly from this page using your current login session. You can also download the full OpenAPI specification to generate client SDKs, import into Postman, or use in automated contract testing pipelines.

Using the Swagger UI​

Expand an endpoint — click any endpoint row to see its full documentation: parameters, request body schema, response schema, and example values.

Try it out — click the Try it out button on an expanded endpoint, fill in the parameters, and click Execute. The Swagger UI sends the real request to the backend and shows the live response. Your current session cookie is used automatically.

Authorization — the backend uses session-cookie authentication. As long as you are logged in, Swagger requests are authenticated. No additional API key is needed for testing in the UI.

Download API Spec​

Click Download API Spec (JSON) to save the full OpenAPI 3.0 specification as a JSON file. Use this to:

  • Generate client SDKs in any language using OpenAPI Generator.
  • Import into Postman or Insomnia for automated testing.
  • Feed into CI pipelines for contract testing.

Open in New Tab​

Click Open in New Tab to open the Swagger UI in a full browser tab, which provides more screen space for complex schemas and response bodies.

Key API Areas​

/api/cyber-vault — manage CyberVault copy jobs, configs, and changelists.

/api/agents — agent registry: register, drain, update, crash timeout.

/api/settings — read and write all system settings.

/api/license — view the current license and capacity per node tier, install a license archive (.zip), and remove installed licenses.

/api/jobs — query job history, cancel and resume jobs.

/api/auth — login, logout, session management.

Tips​

  • Changes made via the Swagger UI are real — they hit the live backend. Be careful when testing write endpoints (POST, PATCH, DELETE) against a production system.
  • The spec is generated by the running console, so it always reflects the installed version.