Reference
This section provides comprehensive reference materials for Grafana IRM, including detailed API documentation for programmatically interacting with different components of the platform.
API reference guides
Grafana IRM brings together functionality from both Grafana OnCall and Grafana Incident. Each component maintains its own API structure, which you can access through the following reference guides:
Grafana OnCall API
The OnCall API provides endpoints for managing alert groups, escalation policies, schedules, and on-call rotations. Use this API to:
- Manage alert groups and their lifecycle
- Configure escalation chains and policies
- Handle on-call schedules and shift swaps
- Set up integrations with monitoring systems
- Configure notification rules and channels
The OnCall API uses a RESTful design pattern and is ideal for automating incident response workflows and notification management.
Grafana Incident API
The Incident API provides endpoints for managing the incident lifecycle, including declarations, updates, and resolutions. Use this API to:
- Declare new incidents
- Manage incident status and lifecycle
- Add and update incident tasks
- Attach and manage incident roles
- Record and retrieve incident timelines
The Incident API uses a JSON/HTTP RPC design pattern and enables you to build custom workflows around incident management processes.
Was this page helpful?
Related resources from Grafana Labs
