Developers
API deprecation policy
Integrators — especially OEM embeds — need a contract that does not break on a Tuesday. This page is the written policy for /api/v1.
Versioning
The current API calendar version is 2026-07-26, also advertised on /api/v1/openapi and the X-Intellescope-Api-Version response header on the OpenAPI document.
Breaking changes
- Breaking changes require a new major path prefix (e.g.
/api/v2) or an explicit sunset. - Deprecated fields and routes remain available for at least 180 days after announcement, with
DeprecationandSunsetHTTP headers where applicable. - Additive fields and new endpoints are not breaking and may ship without notice.
Announcement
Deprecations are announced in product updates, the OpenAPI description, and this page (/docs/api/deprecation).
Soft usage
Unique-observable overage never hard-blocks serving. Alerts fire at 80% and 100% of the soft pool; the difference is invoiced.