Michael Derynck 846b898bb9

* Log (failed) attempt to notify a user with viewer role

* Remove https:// prefix from BASE_URL docker env var

* Fix cloud heartbeat name

* Polishing telegram

* Update docker-compose.yml

* Update plugin README  (#48)

* Update README and screenshot, remove plop for build info since version is now displayed prominently

* Sign build

Co-authored-by: Michael Derynck <michael.derynck@grafana.com>

* Build actions (#38)

* Drone, github action changes

* Minor version updates

* Update frontend dependencies

* Re-enable unit test

Co-authored-by: Michael Derynck <michael.derynck@grafana.com>

* Revert stylelint version (#52)

* Revert stylelint version

* Build plugin as well as lint

* Build in previous step

Co-authored-by: Michael Derynck <michael.derynck@grafana.com>

* Update screenshot (#53)

Co-authored-by: Michael Derynck <michael.derynck@grafana.com>

* oncall images for docs (#55)

* Update README.md

* Top menu fix

* Fix db encoding

* Add api key docs

* Reverting utf8 fix

* bug fixes

* fix for link for OSS version

* Fixing utf8 and docker compose

* 8080 -> 8000 port for consistency

* makeReq

* Fixing images

* Fixing port

* Fixing port

* Fixing port

* Fixing port

* Fixing port

* Fixing port

* Fixing port

* Fixing port

* Replace symlink with file for CHANGELOG.MD (#68)

Co-authored-by: Michael Derynck <michael.derynck@grafana.com>

Co-authored-by: Matias Bordese <mbordese@gmail.com>
Co-authored-by: Matvey Kukuy <Matvey-Kuk@users.noreply.github.com>
Co-authored-by: Innokentii Konstantinov <innokenty.konstantinov@grafana.com>
Co-authored-by: Matvey Kukuy <matvey@amixr.io>
Co-authored-by: Michael Derynck <michael.derynck@grafana.com>
Co-authored-by: Alyssa Wada <101596687+alyssawada@users.noreply.github.com>
Co-authored-by: Yulia Shanyrova <yulia.shanyrova@grafana.com>

2022-06-14 09:14:45 -06:00

2.4 KiB

Raw Blame History

aliases

title

weight

/docs/oncall/latest/oncall-api-reference/

Grafana OnCall HTTP API reference

1300

HTTP API Reference

Use the following guidelines for 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: "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.

Pagination

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.

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 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

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

2.4 KiB Raw Blame History