APIv1

API

REST API reference

The Observer REST API lives at https://api.use.observer/v1. Every endpoint requires Authorization: Bearer <api_key>. Keys are minted per organisation and scoped per capability (read:metrics, write:incidents, etc.). Pagination is cursor-based.

This tab is auto-generated from the OpenAPI 3.1 spec in apps/web/lib/openapi-spec.ts. The same spec drives request validation in production, so the docs and runtime are never out of sync. Pick an operation from the sidebar for parameters, request / response schemas, and a working curl example.

TutorialAuthenticationMint a key, scope it per capability, send the first request.Start here ReferenceList servicesThe most-hit endpoint. Returns paginated services + current verdict.Start here How-toCreate an incidentOpen an incident programmatically and stream updates from your tooling.Start here
Getting started
AuthenticationCommand-line tool
Services
GET /servicesGET /services/{id}
Metrics
GET /metricsGET /metrics/{id}GET /metrics/{id}/historyPOST /metrics/{id}/status
SLOs
GET /slosGET /slos/{id}
Incidents
DELETE /incidents/{id}GET /incidentsGET /incidents/{id}PATCH /incidents/{id}POST /incidentsPOST /incidents/{id}/messagesPOST /incidents/{id}/publishPOST /incidents/{id}/resolvePOST /incidents/from-metric/{metricId}
Maintenances
GET /maintenancesGET /maintenances/{id}PATCH /maintenances/{id}POST /maintenancesPOST /maintenances/{id}/cancelPOST /maintenances/{id}/completePOST /maintenances/{id}/start
Config
GET /config/exportPOST /config/apply
Change events
POST /change-events