Skip to main content
All product APIs use the /api/v1 prefix unless noted. This catalog groups the current route families; individual recipe pages document common requests.

Authorization model

An endpoint can require:
  • an organization permission such as streams.query or alerts.manage;
  • a platform permission such as sys.telemetry.read;
  • resource-level ownership or a relationship/grant;
  • a public share session restricted to one resource.
Do not infer authorization from a display role. Query /api/v1/iam/capabilities for the effective permission and feature snapshot.

Source of truth

This reference documents the common requests of each family. The handlers under src/api/http/routes/ in the source repository define the contract of every route, including routes that have no recipe page. The OpenAPI overview in docs/api/openapi.yaml of that repository covers only part of the surface. When a document and a handler differ, the handler is authoritative.

API introduction

Review base URLs, bearer authentication, pagination, errors, and request conventions.
Last modified on October 26, 2026