API Documentation
Full REST API for integration, automation, and programmatic platform control
OrcaMonitor exposes a comprehensive REST API that gives external systems, custom integrations, and automation tooling full access to all platform functions — devices, alerts, tickets, automation, governance, and more.
The API follows REST conventions with JSON request/response bodies, Bearer token authentication, and standard HTTP status codes. Every endpoint in the platform UI has a corresponding API path — if you can do it in the UI, you can do it via API.
What's Covered
Topics and content in API Documentation
Authentication
All API requests require a Bearer token issued to a service account. Tokens are scoped to the same RBAC permissions as the associated user account. Token rotation is managed via the platform UI.
Devices API
CRUD operations for device records. List devices with filter/sort, retrieve device health history, update metadata, and trigger device-scoped automation playbooks.
Alerts API
Ingest alerts programmatically via POST /api/v1/alerts. List, filter, acknowledge, and close alerts. Retrieve correlation groups and correlated event chains.
Tickets API
Create, list, update, assign, and close tickets. Retrieve ticket audit trails, linked alerts, AI analysis results, and approval history.
Automation API
List playbooks, trigger execution, check execution status, retrieve execution logs, and manage approval requests programmatically.
Audit & Governance API
Retrieve audit log entries with filter/date range, export compliance evidence packages, and check license status via GET /api/v1/license/status.
Highlights
- OpenAPI 3.0 specification available for import into Postman, Insomnia, or code generation tools
- Rate limiting: 1,000 requests per minute per token by default (configurable)
- Pagination: all list endpoints support cursor-based pagination
- Webhook outbound: subscribe to platform events via POST webhook delivery
- API versioning: /api/v1/ — breaking changes always introduce a new version
- Full error response schema with machine-readable error codes
Related Resources
See every module, pricing tier, and deployment option on the OrcaMonitor overview.