HTTP API Reference
Use the following guidelines to use 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: meowmeowmeow"
meowmeowmeow is a valid key for test purposes.
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.
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.
|count||The total number of items. It can be
|next||A link to the next page. It can be
|previous||A link to the previous page. It can be
|results||The data list. Can be
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
|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 Grafana Cloud resources
How to set up and visualize synthetic monitoring at scale with Grafana Cloud
Learn how to use Kubernetes, Grafana Loki, and Grafana Cloud’s synthetic monitoring feature to set up your infrastructure's checks in this GrafanaCONline session.
Using Grafana Cloud to drive manufacturing plant efficiency
This GrafanaCONline session tells how Grafana helps a 75-year-old manufacturing company with product quality and equipment maintenance.