Skip to content

Commit ea93404

Browse files
Docs: Update alerting_notification_channels.md (grafana#21245)
* Update alerting_notification_channels.md Minor edits and fixed stacked heading issue. * Update docs/sources/http_api/alerting_notification_channels.md Co-Authored-By: Marcus Efraimsson <[email protected]> Co-authored-by: Marcus Efraimsson <[email protected]>
1 parent 3667781 commit ea93404

File tree

1 file changed

+28
-30
lines changed

1 file changed

+28
-30
lines changed

docs/sources/http_api/alerting_notification_channels.md

+28-30
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,16 @@ parent = "http_api"
1111

1212
# Alerting Notification Channels API
1313

14+
This page documents the Alerting Notification Channels API.
15+
1416
## Identifier (id) vs unique identifier (uid)
1517

1618
The identifier (id) of a notification channel is an auto-incrementing numeric value and is only unique per Grafana install.
1719

1820
The unique identifier (uid) of a notification channel can be used for uniquely identify a notification channel between
1921
multiple Grafana installs. It's automatically generated if not provided when creating a notification channel. The uid
20-
allows having consistent URL's for accessing notification channels and when syncing notification channels between multiple
21-
Grafana installs, see [alert notification channel provisioning](/administration/provisioning/#alert-notification-channels)
22-
for more information.
22+
allows having consistent URLs for accessing notification channels and when syncing notification channels between multiple
23+
Grafana installations, refer to [alert notification channel provisioning]({{< relref "../administration/provisioning.md#alert-notification-channels" >}}).
2324

2425
The uid can have a maximum length of 40 characters.
2526

@@ -29,7 +30,7 @@ Returns all notification channels that the authenticated user has permission to
2930

3031
`GET /api/alert-notifications`
3132

32-
**Example Request**:
33+
**Example request**:
3334

3435
```http
3536
GET /api/alert-notifications HTTP/1.1
@@ -38,7 +39,7 @@ Content-Type: application/json
3839
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
3940
```
4041

41-
**Example Response**:
42+
**Example response**:
4243

4344
```http
4445
HTTP/1.1 200
@@ -65,13 +66,11 @@ Content-Type: application/json
6566

6667
## Get all notification channels (lookup)
6768

68-
Returns all notification channels, but with less detailed information.
69-
Accessible by any authenticated user and is mainly used by providing
70-
alert notification channels in Grafana UI when configuring alert rule.
69+
Returns all notification channels, but with less detailed information. Accessible by any authenticated user and is mainly used by providing alert notification channels in Grafana UI when configuring alert rule.
7170

7271
`GET /api/alert-notifications/lookup`
7372

74-
**Example Request**:
73+
**Example request**:
7574

7675
```http
7776
GET /api/alert-notifications/lookup HTTP/1.1
@@ -80,7 +79,7 @@ Content-Type: application/json
8079
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
8180
```
8281

83-
**Example Response**:
82+
**Example response**:
8483

8584
```http
8685
HTTP/1.1 200
@@ -109,9 +108,9 @@ Content-Type: application/json
109108

110109
`GET /api/alert-notifications/uid/:uid`
111110

112-
Will return the notification channel given the notification channel uid.
111+
Returns the notification channel given the notification channel uid.
113112

114-
**Example Request**:
113+
**Example request**:
115114

116115
```http
117116
GET /api/alert-notifications/uid/team-a-email-notifier HTTP/1.1
@@ -120,7 +119,7 @@ Content-Type: application/json
120119
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
121120
```
122121

123-
**Example Response**:
122+
**Example response**:
124123

125124
```http
126125
HTTP/1.1 200
@@ -146,9 +145,9 @@ Content-Type: application/json
146145

147146
`GET /api/alert-notifications/:id`
148147

149-
Will return the notification channel given the notification channel id.
148+
Returns the notification channel given the notification channel id.
150149

151-
**Example Request**:
150+
**Example request**:
152151

153152
```http
154153
GET /api/alert-notifications/1 HTTP/1.1
@@ -157,7 +156,7 @@ Content-Type: application/json
157156
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
158157
```
159158

160-
**Example Response**:
159+
**Example response**:
161160

162161
```http
163162
HTTP/1.1 200
@@ -181,11 +180,11 @@ Content-Type: application/json
181180

182181
## Create notification channel
183182

184-
You can find the full list of [supported notifiers](/alerting/notifications/#all-supported-notifier) at the alert notifiers page.
183+
You can find the full list of [supported notifiers](/alerting/notifications/#all-supported-notifier) on the alert notifiers page.
185184

186185
`POST /api/alert-notifications`
187186

188-
**Example Request**:
187+
**Example request**:
189188

190189
```http
191190
POST /api/alert-notifications HTTP/1.1
@@ -205,7 +204,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
205204
}
206205
```
207206

208-
**Example Response**:
207+
**Example response**:
209208

210209
```http
211210
HTTP/1.1 200
@@ -232,7 +231,7 @@ Content-Type: application/json
232231

233232
Updates an existing notification channel identified by uid.
234233

235-
**Example Request**:
234+
**Example request**:
236235

237236
```http
238237
PUT /api/alert-notifications/uid/cIBgcSjkk HTTP/1.1
@@ -253,7 +252,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
253252
}
254253
```
255254

256-
**Example Response**:
255+
**Example response**:
257256

258257
```http
259258
HTTP/1.1 200
@@ -281,7 +280,7 @@ Content-Type: application/json
281280

282281
Updates an existing notification channel identified by id.
283282

284-
**Example Request**:
283+
**Example request**:
285284

286285
```http
287286
PUT /api/alert-notifications/1 HTTP/1.1
@@ -303,7 +302,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
303302
}
304303
```
305304

306-
**Example Response**:
305+
**Example response**:
307306

308307
```http
309308
HTTP/1.1 200
@@ -331,7 +330,7 @@ Content-Type: application/json
331330

332331
Deletes an existing notification channel identified by uid.
333332

334-
**Example Request**:
333+
**Example request**:
335334

336335
```http
337336
DELETE /api/alert-notifications/uid/team-a-email-notifier HTTP/1.1
@@ -340,7 +339,7 @@ Content-Type: application/json
340339
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
341340
```
342341

343-
**Example Response**:
342+
**Example response**:
344343

345344
```http
346345
HTTP/1.1 200
@@ -357,7 +356,7 @@ Content-Type: application/json
357356

358357
Deletes an existing notification channel identified by id.
359358

360-
**Example Request**:
359+
**Example request**:
361360

362361
```http
363362
DELETE /api/alert-notifications/1 HTTP/1.1
@@ -366,7 +365,7 @@ Content-Type: application/json
366365
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
367366
```
368367

369-
**Example Response**:
368+
**Example response**:
370369

371370
```http
372371
HTTP/1.1 200
@@ -384,7 +383,7 @@ You can find the full list of [supported notifiers](/alerting/notifications/#all
384383

385384
`POST /api/alert-notifications/test`
386385

387-
**Example Request**:
386+
**Example request**:
388387

389388
```http
390389
POST /api/alert-notifications/test HTTP/1.1
@@ -400,7 +399,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
400399
}
401400
```
402401

403-
**Example Response**:
402+
**Example response**:
404403

405404
```http
406405
HTTP/1.1 200
@@ -410,4 +409,3 @@ Content-Type: application/json
410409
"message": "Test notification sent"
411410
}
412411
```
413-

0 commit comments

Comments
 (0)