335c8fe65b
# What this PR does ## Which issue(s) this PR fixes ## Checklist - [ ] Tests updated - [ ] Documentation added - [ ] `CHANGELOG.md` updated --------- Co-authored-by: Joey Orlando <joey.orlando@grafana.com>
113 lines
2.7 KiB
Markdown
113 lines
2.7 KiB
Markdown
---
|
|
aliases:
|
|
- /docs/oncall/latest/oncall-api-reference/alerts/
|
|
canonical: https://grafana.com/docs/oncall/latest/oncall-api-reference/alerts/
|
|
title: Alerts HTTP API
|
|
weight: 100
|
|
---
|
|
|
|
# List Alerts
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/alerts/" \
|
|
--request GET \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json"
|
|
```
|
|
|
|
The above command returns JSON structured in the following way:
|
|
|
|
```json
|
|
{
|
|
"count": 3,
|
|
"next": null,
|
|
"previous": null,
|
|
"results": [
|
|
{
|
|
"id": "AA74DN7T4JQB6",
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"created_at": "2020-05-11T20:07:43Z",
|
|
"payload": {
|
|
"state": "alerting",
|
|
"title": "[Alerting] Test notification",
|
|
"ruleId": 0,
|
|
"message": "Someone is testing the alert notification within Grafana.",
|
|
"ruleUrl": "{{API_URL}}/",
|
|
"ruleName": "Test notification",
|
|
"evalMatches": [
|
|
{
|
|
"tags": null,
|
|
"value": 100,
|
|
"metric": "High value"
|
|
},
|
|
{
|
|
"tags": null,
|
|
"value": 200,
|
|
"metric": "Higher Value"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "AR9SSYFKE2PV7",
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"created_at": "2020-05-11T20:07:54Z",
|
|
"payload": {
|
|
"state": "alerting",
|
|
"title": "[Alerting] Test notification",
|
|
"ruleId": 0,
|
|
"message": "Someone is testing the alert notification within Grafana.",
|
|
"ruleUrl": "{{API_URL}}/",
|
|
"ruleName": "Test notification",
|
|
"evalMatches": [
|
|
{
|
|
"tags": null,
|
|
"value": 100,
|
|
"metric": "High value"
|
|
},
|
|
{
|
|
"tags": null,
|
|
"value": 200,
|
|
"metric": "Higher Value"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": "AWJQSGEYYUFGH",
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"created_at": "2020-05-11T20:07:58Z",
|
|
"payload": {
|
|
"state": "alerting",
|
|
"title": "[Alerting] Test notification",
|
|
"ruleId": 0,
|
|
"message": "Someone is testing the alert notification within Grafana.",
|
|
"ruleUrl": "{{API_URL}}/",
|
|
"ruleName": "Test notification",
|
|
"evalMatches": [
|
|
{
|
|
"tags": null,
|
|
"value": 100,
|
|
"metric": "High value"
|
|
},
|
|
{
|
|
"tags": null,
|
|
"value": 200,
|
|
"metric": "Higher Value"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
The following available filter parameters should be provided as `GET` arguments:
|
|
|
|
- `id`
|
|
- `alert_group_id`
|
|
- `search`—string-based inclusion search by alert payload
|
|
|
|
**HTTP request**
|
|
|
|
`GET {{API_URL}}/api/v1/alerts/`
|