HTTP API
HTTP API
The complete SnugNut HTTP surface, generated from the server's own OpenAPI specifications. Each service is one page: its endpoints listed as method and path rows, expanding to full request/response documentation and a Try It panel that calls the server the specs were exported for. The index on the right of a service page jumps to any endpoint.
Two conventions to know before calling anything:
- Most endpoints live under
/api/v1and require a bearer JWT or API key. Auth sign-in flows, OAuth, SCIM provisioning, health, and the WebSocket upgrades live at the root. - Responses are wrapped in the standard envelope; the schemas here show the payload inside it.
The specs are regenerated from the code on every change, and the test suite fails if an endpoint exists that these pages do not show.