Skip to main content

Alerts API overview

This guide documents the public endpoints under /v1/alerts used to inspect current and historical alert state.

Common rules

  • Authentication: Authorization: Bearer <token>
  • Environment scoping: the bearer token maps to a tenant (environmentId), and all queries are automatically restricted to that environment
  • Time format: ISO 8601 UTC, for example 2025-11-13T12:00:00Z
  • Pagination: where applicable, page is 1-based and limit has a maximum of 100

Endpoints

  • GET /v1/alerts - list active alerts
  • GET /v1/alerts/{alertId} - get a single alert view
  • GET /v1/alerts/{alertId}/events - list alert events
  • GET /v1/alerts/{alertId}/events/{sequenceNumber} - fetch a specific event

All endpoints are tenant-scoped via your bearer token.