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 the API specification. 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 started2
AuthenticationCommand-line tool
Services2
GET /servicesGET /services/{id}
Metrics4
GET /metricsGET /metrics/{id}GET /metrics/{id}/historyPOST /metrics/{id}/status
SLOs2
GET /slosGET /slos/{id}
Incidents9
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}
Maintenances7
GET /maintenancesGET /maintenances/{id}PATCH /maintenances/{id}POST /maintenancesPOST /maintenances/{id}/cancelPOST /maintenances/{id}/completePOST /maintenances/{id}/start
Config2
GET /config/exportPOST /config/apply
Change events1
POST /change-events