This is archived documentation for v1.0.x. Go to the latest version.
HTTP API Reference
Use the following guidelines for the Grafana OnCall API.
To authorize, use the Authorization header:
# With shell, you can just pass the correct header with each request curl "api_endpoint_here" --header "Authorization: "api_key_here""
Grafana OnCall uses API keys to allow access to the API. You can request a new OnCall API key in OnCall -> Settings page.
An API key is specific to a user and a Grafana stack. If you want to switch to a different stack configuration, request a different API key.
List endpoints such as List Integrations or List Alert Groups return multiple objects.
The OnCall API returns them in pages. Note that the page size may vary.
|The total number of items. It can be |
|A link to the next page. It can be |
|A link to the previous page. It can be |
|The data list. Can be |
Grafana OnCall provides rate limits to ensure alert group notifications will be delivered to your Slack workspace even when some integrations produce a large number of alerts.
Monitoring integrations Rate Limits
Rate limited response HTTP status: 429
|Alerts from each integration||300||5 minutes|
|Alerts from the whole team||500||5 minutes|
API rate limits
You can reduce or increase rate limits depending on platform status.
|API requests per API key||300||5 minutes|
Related Oncall resources
Getting started with Grafana OnCall for on-call management
This webinar goes over initial Grafana OnCall configuration, setting up an on-call management process, grouping, alert rendering, and organizing runbooks.
Unified alerting and on-call management in Grafana
In this webinar, we’ll demo the Grafana 8 unified alerting system, and introduce Grafana OnCall, our on-call management tool to resolve incidents faster.
Reducing resolution time (MTTR) with the Grafana Stack: Metrics, logs, tracing, & on-call management
See a live demo of Grafana OnCall, and how to correlate your metrics, logs, and traces to reduce you /MTTR using Grafana’s “single pane of glass” approach.