API & Auth
API Guide
Response conventions, error format, and how every resource maps to REST endpoints.
MonSPHERE's REST API follows one consistent set of conventions across all 21 services fronted by the Gateway.
Base URL
https://api.monsphere.com/api/v1 (self-hosted: your Gateway's host, default port 8089).
Response envelope
List endpoints return { data: [...], meta: { page, pageSize, totalItems } }. Single-resource endpoints return the resource directly. See Pagination & Filtering for query parameters.
Errors
Errors return a consistent JSON body with an error code and message — for example 403 { "error": "quota_exceeded", "message": "..." } when a plan limit is hit, or 401 { "error": "unauthorized" } for a missing/invalid credential.
Resource map
| Resource | Base path |
|---|---|
| Monitors | /monitors |
| Dashboards | /organizations/:orgId/dashboards |
| Alert rules | /organizations/:orgId/alert-rules |
| Incidents | /incidents |
| Reports | /organizations/:orgId/reports |
| Roles | /organizations/:orgId/roles |
| API Keys | /organizations/:orgId/api-keys |
| Subscription | /organizations/:orgId/subscription |
| Platform Admin | /platform-admin/* (requires isPlatformAdmin) |
Full auth details live in Authentication; SDKs and webhook docs live in the Developer Center.