Endpoints Reference
This reference lists REST endpoints for engineers and platform administrators. The docs build renders
the endpoint pages from the OpenAPI schema committed in OpenTremor-core/docs/openapi.json. A
running instance serves its schema at /v1/openapi.json and an interactive API view at /v1/docs.
Each endpoint page lists the route, its purpose and access requirements, parameters, request and response bodies, examples, and error statuses.
- Authentication. Pass an API key in the
X-API-Keyheader, or sign in to get a session cookie. See Set Up Authentication. - Validation errors. Every route returns
422when the request does not match its schema. The generated pages omit that status. - Examples. Generated examples use placeholders such as
"string"and omit fields whose values are null.
Core & SessionsHealth checks, API keys, sessions, 2FA and OAuth for agents
SSO & SCIMPer-org single sign-on, social login and SCIM provisioning
Organizations, Teams & InvitationsOrg info, membership, roles, teams, invitation links and search
Packs & RulesPack discovery, analysis jobs, custom rules and rule categories
LLM Credentials, Billing & FindingsLLM connections, allowed models, quota and usage, findings triage and related settings
Integrations, Resources & ReportsCode hosts, repositories, products, notifications, resources and reports
Metrics & AuditUsage and span metrics, the structured audit log and streaming sinks
Platform AdminCross-tenant superadmin endpoints for orgs, users, settings, pricing, network access and backups