Skip to content

Reference

Auto-generated from the control plane's OpenAPI schema. Pick a resource group below, or hit the raw schema at /api/openapi.json.

Two ways to explore

  • Per-resource pages below — best for reading and linking.
  • Swagger UI on a running control plane — best for sending requests interactively.

Resource groups

GroupEndpointsUse it for
Auth4Mint and revoke API tokens; identify the current caller.
Federations3Read and update federation-wide config (mode, webhooks).
Hubs2Read the federation's hub state and activity log.
Notifications4List and acknowledge per-user notifications.
Self-Host2Start a self-host purchase; read your licence + support state.
Spokes11Provision, action, and inspect spokes. The biggest surface — most automation lives here.
Health2Liveness probe + version metadata. No auth.

Released under the GPL v3 license.