576fecf6d3
Related to https://github.com/grafana/irm/issues/332 (see https://github.com/grafana/oncall/pull/5440 and https://github.com/grafana/oncall/pull/5446 for the related UI changes) --------- Co-authored-by: Matt Thorning <matt.thorning@grafana.com>
161 lines
6 KiB
Markdown
161 lines
6 KiB
Markdown
---
|
|
canonical: https://grafana.com/docs/oncall/latest/oncall-api-reference/personal_notification_rules/
|
|
title: Personal notification rules HTTP API
|
|
weight: 0
|
|
refs:
|
|
pagination:
|
|
- pattern: /docs/oncall/
|
|
destination: /docs/oncall/<ONCALL_VERSION>/oncall-api-reference/#pagination
|
|
- pattern: /docs/grafana-cloud/
|
|
destination: /docs/grafana-cloud/alerting-and-irm/oncall/oncall-api-reference/#pagination
|
|
---
|
|
|
|
# Personal notification rules HTTP API
|
|
|
|
## Post a personal notification rule
|
|
|
|
**Required permission**: `grafana-oncall-app.user-settings:write` (user authentication only)
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/personal_notification_rules/" \
|
|
--request POST \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json" \
|
|
--data '{
|
|
"user_id": "U4DNY931HHJS5",
|
|
"type": "notify_by_sms"
|
|
}'
|
|
```
|
|
|
|
The above command returns JSON structured in the following way:
|
|
|
|
```json
|
|
{
|
|
"id": "NT79GA9I7E4DJ",
|
|
"user_id": "U4DNY931HHJS5",
|
|
"position": 0,
|
|
"important": false,
|
|
"type": "notify_by_sms"
|
|
}
|
|
```
|
|
|
|
| Parameter | Required | Description |
|
|
| ----------- | :------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `user_id` | Yes | User ID |
|
|
| `position` | Optional | Personal notification rules execute one after another starting from `position=0`. `Position=-1` will put the escalation policy to the end of the list. A new escalation policy created with a position of an existing escalation policy will move the old one (and all following) down on the list. |
|
|
| `type` | Yes | One of: `wait`, `notify_by_slack`, `notify_by_sms`, `notify_by_phone_call`, `notify_by_telegram`, `notify_by_email`, `notify_by_mobile_app`, `notify_by_mobile_app_critical`, `notify_by_webhook` or `notify_by_msteams` (**NOTE** `notify_by_msteams` is only available on Grafana Cloud). |
|
|
| `duration` | Optional | A time in seconds to wait (when `type=wait`). Can be one of 60, 300, 900, 1800, or 3600. |
|
|
| `important` | Optional | Boolean value indicates if a rule is "important". Default is `false`. |
|
|
|
|
**HTTP request**
|
|
|
|
`POST {{API_URL}}/api/v1/personal_notification_rules/`
|
|
|
|
## Get personal notification rule
|
|
|
|
**Required permission**: `grafana-oncall-app.user-settings:read` (user authentication only)
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/personal_notification_rules/ND9EHN5LN1DUU/" \
|
|
--request GET \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json"
|
|
```
|
|
|
|
The above command returns JSON structured in the following way:
|
|
|
|
```json
|
|
{
|
|
"id": "ND9EHN5LN1DUU",
|
|
"user_id": "U4DNY931HHJS5",
|
|
"position": 1,
|
|
"duration": 300,
|
|
"important": false,
|
|
"type": "wait"
|
|
}
|
|
```
|
|
|
|
**HTTP request**
|
|
|
|
`GET {{API_URL}}/api/v1/personal_notification_rules/<PERSONAL_NOTIFICATION_RULE_ID>/`
|
|
|
|
## List personal notification rules
|
|
|
|
**Required permission**: `grafana-oncall-app.user-settings:read` (user authentication only)
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/personal_notification_rules/" \
|
|
--request GET \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json"
|
|
```
|
|
|
|
The above command returns JSON structured in the following ways:
|
|
|
|
```json
|
|
{
|
|
"count": 4,
|
|
"next": null,
|
|
"previous": null,
|
|
"results": [
|
|
{
|
|
"id": "NT79GA9I7E4DJ",
|
|
"user_id": "U4DNY931HHJS5",
|
|
"position": 0,
|
|
"important": false,
|
|
"type": "notify_by_sms"
|
|
},
|
|
{
|
|
"id": "ND9EHN5LN1DUU",
|
|
"user_id": "U4DNY931HHJS5",
|
|
"position": 1,
|
|
"duration": 300,
|
|
"important": false,
|
|
"type": "wait"
|
|
},
|
|
{
|
|
"id": "NEF49YQ1HNPDD",
|
|
"user_id": "U4DNY931HHJS5",
|
|
"position": 2,
|
|
"important": false,
|
|
"type": "notify_by_phone_call"
|
|
},
|
|
{
|
|
"id": "NWAL6WFJNWDD8",
|
|
"user_id": "U4DNY931HHJS5",
|
|
"position": 0,
|
|
"important": true,
|
|
"type": "notify_by_phone_call"
|
|
}
|
|
],
|
|
"current_page_number": 1,
|
|
"page_size": 50,
|
|
"total_pages": 1
|
|
}
|
|
```
|
|
|
|
> **Note**: The response is [paginated](ref:pagination). You may need to make multiple requests to get all records.
|
|
|
|
The following available filter parameters should be provided as `GET` arguments:
|
|
|
|
- `user_id`
|
|
- `important`
|
|
|
|
**HTTP Request**
|
|
|
|
`GET {{API_URL}}/api/v1/personal_notification_rules/`
|
|
|
|
## Delete a personal notification rule
|
|
|
|
**Required permission**: `grafana-oncall-app.user-settings:write` (user authentication only)
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/personal_notification_rules/NWAL6WFJNWDD8/" \
|
|
--request DELETE \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json"
|
|
```
|
|
|
|
**HTTP request**
|
|
|
|
`DELETE {{API_URL}}/api/v1/personal_notification_rules/<PERSONAL_NOTIFICATION_RULE_ID>/`
|