API Reference

Integrate with our REST API to push external monitoring metrics.

The DeployPilotOS REST API provides programmatic access to your entire SRE workspace. Integrate seamlessly with CI/CD pipelines, external APM tools (Datadog, New Relic), and custom internal dashboards.

Global Base URL

https://api.deploypilotos.com/v1

Authentication & Rate Limits

Pass your workspace API key in the Authorization header. All API endpoints are rate-limited to 1,000 requests per minute per workspace IP.

Authorization: Bearer dp_live_abc123def456ghi789

1. Telemetry & Metrics

POST /telemetry/ingest

Push high-frequency metrics to the AI diagnosis engine. Automatically triggers an incident if thresholds are breached.

// Request Payload{ "serviceId": "api-gateway", "timestamp": "2026-07-18T23:47:02Z", "metrics": { "cpu_percent": 89.4, "memory_mb": 4021, "latency_ms": 1205 }, "tags": ["region:us-east-1", "env:production"] }

2. Incident Management

GET /incidents

Retrieve a paginated list of all active or resolved incidents in the workspace.

// Query Parameters?status=open&severity=P1&limit=50
// Response (200 OK){ "data": [ { "id": "inc_78432", "status": "open", "severity": "P1", "title": "API Timeout Cascade", "mttr": null, "aiDiagnosis": { "rootCause": "DB Connection Pool Exhausted", "confidence": 98 } } ], "pagination": { "hasMore": false } }

PUT /incidents/:id/resolve

Manually mark an incident as resolved. This will automatically trigger the AI Post-Mortem generator.

3. Runbooks & Automations

POST /runbooks/execute

Manually dispatch a specific automated playbook against a service cluster.

// Request Payload{ "runbookId": "rb_restart_pods", "serviceId": "api-gateway", "overrideParams": { "force": true, "gracePeriodSeconds": 0 } }