Documentation
Unified API
OpsOrch provides a single, consistent API surface for all your operational data.
The Query Pattern
Most OpsOrch endpoints follow a POST /query pattern. This allows for complex, structured filtering payloads that wouldn’t fit in query parameters.
POST/incidents/query
json
{
"statuses": ["open", "investigating"],
"severities": ["sev1", "sev2"],
"scope": {
"service": "payments-api",
"environment": "production"
},
"limit": 20
}Authentication
All API requests must be authenticated. OpsOrch supports two modes:
- Service-to-Service (API Token)
Use the
X-OpsOrch-Tokenheader. (Currently for Enterprise / specific internal use cases). - User Session (Cookie)
The Console uses secure, HTTP-only session cookies managed by the Next.js backend.
Endpoint Reference
Incidents
| POST /incidents/query | List incidents matching filters |
| GET /incidents/:id | Get detailed incident by ID |
| PATCH /incidents/:id | Update status, severity, or metadata |
| GET /incidents/:id/timeline | Fetch timeline entries |
| POST /incidents/:id/timeline | Append to incident timeline |
Alerts
| POST /alerts/query | Query alerts by status, severity, or scope |
| GET /alerts/:id | Get alert details |
Metrics
| POST /metrics/query | Query time-series data |
| GET /metrics/describe | List available metric names and labels |
Logs
| POST /logs/query | Search logs with structured expressions |
Services
| POST /services/query | List services from catalog |
| GET /services/:id/graph | Get dependency graph for a service |
Deployments
| POST /deployments/query | Query deployments by status or scope |
| GET /deployments/:id | Get deployment details |
Tickets
| POST /tickets/query | Search tickets by status or scope |
| GET /tickets/:id | Get ticket details |
Teams
| POST /teams/query | Find teams by name or scope |
| GET /teams/:id | Get team details |
| GET /teams/:id/members | List team members |
Orchestration (Runbooks)
| POST /orchestration/plans/query | Query runbook plans |
| GET /orchestration/plans/:id | Get plan details |
| POST /orchestration/runs/query | Query run status |
| GET /orchestration/runs/:id | Get run details |
| POST /orchestration/runs | Start a run from a plan |
| POST /orchestration/runs/:runId/steps/:stepId/complete | Complete a manual step |