--- title: "Alert groups HTTP API | Grafana OnCall documentation" description: "Alert groups HTTP API List alert groups Required permission: grafana-oncall-app.alert-groups:read shell Copy curl \"{{API_URL}}/api/v1/alert_groups/\" \\ --request GET \\ --header \"Authorization: meowmeowmeow\" \\ --header \"Content-Type: application/json\" The above command returns JSON structured in the following way:" --- > For a curated documentation index, see [llms.txt](/llms.txt). For the complete documentation index, see [llms-full.txt](/llms-full.txt). # Alert groups HTTP API ## List alert groups **Required permission**: `grafana-oncall-app.alert-groups:read` shell ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```shell curl "{{API_URL}}/api/v1/alert_groups/" \ --request GET \ --header "Authorization: meowmeowmeow" \ --header "Content-Type: application/json" ``` The above command returns JSON structured in the following way: JSON ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```json { "count": 1, "next": null, "previous": null, "results": [ { "id": "I68T24C13IFW1", "integration_id": "CFRPV98RPR1U8", "route_id": "RIYGUJXCPFHXY", "alerts_count": 3, "state": "resolved", "created_at": "2020-05-19T12:37:01.430444Z", "resolved_at": "2020-05-19T13:37:01.429805Z", "acknowledged_at": null, "acknowledged_by": null, "resolved_by": "UCGEIXI1MR1NZ", "title": "Memory above 90% threshold", "permalinks": { "slack": "https://ghostbusters.slack.com/archives/C1H9RESGA/p135854651500008", "telegram": "https://t.me/c/5354/1234?thread=1234" }, "silenced_at": "2020-05-19T13:37:01.429805Z", "last_alert": { "id": "AA74DN7T4JQB6", "alert_group_id": "I68T24C13IFW1", "created_at": "2020-05-11T20:08: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" } ] } }, } ], "current_page_number": 1, "page_size": 50, "total_pages": 1 } ``` > **Note**: The response is [paginated](/docs/oncall/latest/oncall-api-reference/#pagination). You may need to make multiple requests to get all records. These available filter parameters should be provided as `GET` arguments: - `id` (Exact match, alert group ID) - `route_id` (Exact match, route ID) - `integration_id` (Exact match, integration ID) - `label` (Matching labels, can be passed multiple times; expected format: `key1:value1`) - `team_id` (Exact match, team ID) - `started_at` (A “{start}\_{end}” ISO 8601 timestamp range; expected format: `%Y-%m-%dT%H:%M:%S_%Y-%m-%dT%H:%M:%S`) - `state` (Possible values: `new`, `acknowledged`, `resolved` or `silenced`) **HTTP request** `GET {{API_URL}}/api/v1/alert_groups/` ## Alert group details **Required permission**: `grafana-oncall-app.alert-groups:read` shell ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```shell curl "{{API_URL}}/api/v1/alert_groups/I68T24C13IFW1" \ --request GET \ --header "Authorization: meowmeowmeow" ``` **HTTP request** `GET {{API_URL}}/api/v1/alert_groups/` ## Acknowledge an alert group **Required permission**: `grafana-oncall-app.alert-groups:write` (user authentication only) shell ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```shell curl "{{API_URL}}/api/v1/alert_groups/I68T24C13IFW1/acknowledge" \ --request POST \ --header "Authorization: meowmeowmeow" ``` **HTTP request** `POST {{API_URL}}/api/v1/alert_groups//acknowledge` ## Unacknowledge an alert group **Required permission**: `grafana-oncall-app.alert-groups:write` (user authentication only) shell ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```shell curl "{{API_URL}}/api/v1/alert_groups/I68T24C13IFW1/unacknowledge" \ --request POST \ --header "Authorization: meowmeowmeow" ``` **HTTP request** `POST {{API_URL}}/api/v1/alert_groups//unacknowledge` ## Resolve an alert group **Required permission**: `grafana-oncall-app.alert-groups:write` (user authentication only) shell ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```shell curl "{{API_URL}}/api/v1/alert_groups/I68T24C13IFW1/resolve" \ --request POST \ --header "Authorization: meowmeowmeow" ``` **HTTP request** `POST {{API_URL}}/api/v1/alert_groups//resolve` ## Unresolve an alert group **Required permission**: `grafana-oncall-app.alert-groups:write` (user authentication only) shell ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```shell curl "{{API_URL}}/api/v1/alert_groups/I68T24C13IFW1/unresolve" \ --request POST \ --header "Authorization: meowmeowmeow" ``` **HTTP request** `POST {{API_URL}}/api/v1/alert_groups//unresolve` ## Silence an alert group **Required permission**: `grafana-oncall-app.alert-groups:write` (user authentication only) shell ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```shell curl "{{API_URL}}/api/v1/alert_groups/I68T24C13IFW1/silence" \ --request POST \ --header "Authorization: meowmeowmeow" \ --header "Content-Type: application/json" \ --data '{ "delay": 10800 }' ``` **HTTP request** `POST {{API_URL}}/api/v1/alert_groups//silence` Expand table | Parameter | Required | Description | |-----------|----------|--------------------------------------------------------------------------| | `delay` | Yes | The duration of silence in seconds, `-1` for silencing the alert forever | ## Unsilence an alert group **Required permission**: `grafana-oncall-app.alert-groups:write` (user authentication only) shell ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```shell curl "{{API_URL}}/api/v1/alert_groups/I68T24C13IFW1/unsilence" \ --request POST \ --header "Authorization: meowmeowmeow" ``` **HTTP request** `POST {{API_URL}}/api/v1/alert_groups//unsilence` ## Delete an alert group **Required permission**: `grafana-oncall-app.alert-groups:write` shell ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```shell curl "{{API_URL}}/api/v1/alert_groups/I68T24C13IFW1/" \ --request DELETE \ --header "Authorization: meowmeowmeow" \ --header "Content-Type: application/json" \ --data '{ "mode": "wipe" }' ``` Expand table | Parameter | Required | Description | |-----------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `mode` | No | The default value for this parameter is `wipe`. Using `wipe` will delete the content of the alert group but keep the metadata, which is helpful if you’ve sent sensitive information to OnCall. On the other hand, passing `delete` will fully erase the alert group and its metadata, as well as delete related messages in Slack and other platforms. | > **NOTE:** `DELETE` can take a few moments to delete alert groups because Grafana OnCall interacts with 3rd party APIs such as Slack. Please check objects using `GET` to be sure the data is removed. **HTTP request** `DELETE {{API_URL}}/api/v1/alert_groups/`