6b40f95033
Co-authored-by: Eve832 <eve.meelan@grafana.com>
Co-authored-by: Francisco Montes de Oca <nevermind89x@gmail.com>
Co-authored-by: Ildar Iskhakov <ildar.iskhakov@grafana.com>
Co-authored-by: Innokentii Konstantinov <innokenty.konstantinov@grafana.com>
Co-authored-by: Julia <ferril.darkdiver@gmail.com>
Co-authored-by: maskin25 <kengurek@gmail.com>
Co-authored-by: Matias Bordese <mbordese@gmail.com>
Co-authored-by: Matvey Kukuy <motakuk@gmail.com>
Co-authored-by: Michael Derynck <michael.derynck@grafana.com>
Co-authored-by: Richard Hartmann <richih@richih.org>
Co-authored-by: Robby Milo <robbymilo@fastmail.com>
Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
Co-authored-by: Vadim Stepanov <vadimkerr@gmail.com>
Co-authored-by: Yulia Shanyrova <yulia.shanyrova@grafana.com>
110 lines
No EOL
3.2 KiB
Markdown
110 lines
No EOL
3.2 KiB
Markdown
+++
|
|
title = "Alerts HTTP API"
|
|
aliases = ["/docs/grafana-cloud/oncall/oncall-api-reference/alerts"]
|
|
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:
|
|
|
|
* `alert_group_id`
|
|
* `search`—string-based inclusion search by alert payload
|
|
|
|
**HTTP request**
|
|
|
|
`GET {{API_URL}}/api/v1/alerts/` |