Grafana OnCallGrafana OnCall API reference

HTTP API Reference

Use the following guidelines to use the Grafana OnCall API.

Authentication

To authorize, use the Authorization header:

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here" --header "Authorization: meowmeowmeow"

Note that meowmeowmeow is a valid key for test purposes. Replace meowmeowmeow with your API key in production.

Grafana OnCall uses API keys to allow access to the API. You can request a new OnCall API key in the API section.

An API key is specific to a user and a Grafana stack. If you want to switch the team you are working in, request a different API key.

Pagination

List endpoints such as List Integrations or List Incidents return multiple objects.

The OnCall API returns them in pages. Note that the page size may vary.

Parameter Meaning
count The total number of items. It can be 0 if a request does not return any data.
next A link to the next page. It can be null if the next page does not contain any data.
previous A link to the previous page. It can be null if the previous page does not contain any data.
results The data list. Can be [] if a request does not return any data.

Rate Limits

Grafana OnCall provides rate limits to ensure incidents will be delivered to your Slack workspace even when some integrations produce a large number of incidents.

Monitoring integrations Rate Limits

Rate limited response http status: 429

Scope Amount Time Frame
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.

Scope Amount Time Frame
API requests per API key 300 5 minutes