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>
142 lines
No EOL
3.6 KiB
Markdown
142 lines
No EOL
3.6 KiB
Markdown
+++
|
|
title = "Personal Notification Rules HTTP API"
|
|
aliases = ["/docs/grafana-cloud/oncall/oncall-api-reference/personal_notification_rules/"]
|
|
weight = 800
|
|
+++
|
|
|
|
# Post a personal notification rule
|
|
|
|
```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`.
|
|
`duration` | Optional | A time in secs when type `wait` is chosen for `type`.
|
|
`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
|
|
|
|
```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
|
|
|
|
```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"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
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
|
|
|
|
|
|
```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>/` |