2019-03-26 19:37:02 +08:00
+++
title = "Alerting Notification Channels HTTP API "
description = "Grafana Alerting Notification Channel HTTP API"
keywords = ["grafana", "http", "documentation", "api", "alerting", "alerts", "notifications"]
aliases = []
type = "docs"
[menu.docs]
name = "Alerting Notification Channels"
parent = "http_api"
+++
# Alerting Notification Channels API
2019-12-31 23:30:53 +08:00
This page documents the Alerting Notification Channels API.
2019-03-26 19:37:02 +08:00
## Identifier (id) vs unique identifier (uid)
The identifier (id) of a notification channel is an auto-incrementing numeric value and is only unique per Grafana install.
The unique identifier (uid) of a notification channel can be used for uniquely identify a notification channel between
multiple Grafana installs. It's automatically generated if not provided when creating a notification channel. The uid
2019-12-31 23:30:53 +08:00
allows having consistent URLs for accessing notification channels and when syncing notification channels between multiple
Grafana installations, refer to [alert notification channel provisioning ]({{< relref "../administration/provisioning.md#alert-notification-channels" >}} ).
2019-03-26 19:37:02 +08:00
The uid can have a maximum length of 40 characters.
## Get all notification channels
Returns all notification channels that the authenticated user has permission to view.
`GET /api/alert-notifications`
2019-12-31 23:30:53 +08:00
**Example request**:
2019-03-26 19:37:02 +08:00
```http
GET /api/alert-notifications HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
2019-12-31 23:30:53 +08:00
**Example response**:
2019-03-26 19:37:02 +08:00
```http
HTTP/1.1 200
Content-Type: application/json
[
{
"id": 1,
"uid": "team-a-email-notifier",
"name": "Team A",
"type": "email",
"isDefault": false,
"sendReminder": false,
"disableResolveMessage": false,
"settings": {
2019-05-28 22:02:14 +08:00
"addresses": "dev@grafana.com"
2019-03-26 19:37:02 +08:00
},
"created": "2018-04-23T14:44:09+02:00",
"updated": "2018-08-20T15:47:49+02:00"
}
]
```
2019-08-13 02:03:48 +08:00
## Get all notification channels (lookup)
2019-12-31 23:30:53 +08:00
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.
2019-08-13 02:03:48 +08:00
`GET /api/alert-notifications/lookup`
2019-12-31 23:30:53 +08:00
**Example request**:
2019-08-13 02:03:48 +08:00
```http
GET /api/alert-notifications/lookup HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
2019-12-31 23:30:53 +08:00
**Example response**:
2019-08-13 02:03:48 +08:00
```http
HTTP/1.1 200
Content-Type: application/json
[
{
"id": 1,
"uid": "000000001",
"name": "Test",
"type": "email",
"isDefault": false
},
{
"id": 2,
"uid": "000000002",
"name": "Slack",
"type": "slack",
"isDefault": false
}
]
```
2019-03-26 19:37:02 +08:00
## Get notification channel by uid
`GET /api/alert-notifications/uid/:uid`
2019-12-31 23:30:53 +08:00
Returns the notification channel given the notification channel uid.
2019-03-26 19:37:02 +08:00
2019-12-31 23:30:53 +08:00
**Example request**:
2019-03-26 19:37:02 +08:00
```http
GET /api/alert-notifications/uid/team-a-email-notifier HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
2019-12-31 23:30:53 +08:00
**Example response**:
2019-03-26 19:37:02 +08:00
```http
HTTP/1.1 200
Content-Type: application/json
{
"id": 1,
"uid": "team-a-email-notifier",
"name": "Team A",
"type": "email",
"isDefault": false,
"sendReminder": false,
"disableResolveMessage": false,
"settings": {
2019-05-28 22:02:14 +08:00
"addresses": "dev@grafana.com"
2019-03-26 19:37:02 +08:00
},
"created": "2018-04-23T14:44:09+02:00",
"updated": "2018-08-20T15:47:49+02:00"
}
```
## Get notification channel by id
`GET /api/alert-notifications/:id`
2019-12-31 23:30:53 +08:00
Returns the notification channel given the notification channel id.
2019-03-26 19:37:02 +08:00
2019-12-31 23:30:53 +08:00
**Example request**:
2019-03-26 19:37:02 +08:00
```http
GET /api/alert-notifications/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
2019-12-31 23:30:53 +08:00
**Example response**:
2019-03-26 19:37:02 +08:00
```http
HTTP/1.1 200
Content-Type: application/json
{
"id": 1,
"uid": "team-a-email-notifier",
"name": "Team A",
"type": "email",
"isDefault": false,
"sendReminder": false,
"disableResolveMessage": false,
"settings": {
2019-05-28 22:02:14 +08:00
"addresses": "dev@grafana.com"
2019-03-26 19:37:02 +08:00
},
"created": "2018-04-23T14:44:09+02:00",
"updated": "2018-08-20T15:47:49+02:00"
}
```
## Create notification channel
2019-12-31 23:30:53 +08:00
You can find the full list of [supported notifiers ](/alerting/notifications/#all-supported-notifier ) on the alert notifiers page.
2019-03-26 19:37:02 +08:00
`POST /api/alert-notifications`
2019-12-31 23:30:53 +08:00
**Example request**:
2019-03-26 19:37:02 +08:00
```http
POST /api/alert-notifications HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
2019-03-29 16:42:38 +08:00
"uid": "new-alert-notification", // optional
2019-03-26 19:37:02 +08:00
"name": "new alert notification", //Required
"type": "email", //Required
"isDefault": false,
"sendReminder": false,
"settings": {
2019-05-28 22:02:14 +08:00
"addresses": "dev@grafana.com"
2019-03-26 19:37:02 +08:00
}
}
```
2019-12-31 23:30:53 +08:00
**Example response**:
2019-03-26 19:37:02 +08:00
```http
HTTP/1.1 200
Content-Type: application/json
{
"id": 1,
2019-03-29 16:42:38 +08:00
"uid": "new-alert-notification",
2019-03-26 19:37:02 +08:00
"name": "new alert notification",
"type": "email",
"isDefault": false,
"sendReminder": false,
"settings": {
2019-05-28 22:02:14 +08:00
"addresses": "dev@grafana.com"
2019-03-26 19:37:02 +08:00
},
"created": "2018-04-23T14:44:09+02:00",
"updated": "2018-08-20T15:47:49+02:00"
}
```
## Update notification channel by uid
`PUT /api/alert-notifications/uid/:uid`
Updates an existing notification channel identified by uid.
2019-12-31 23:30:53 +08:00
**Example request**:
2019-03-26 19:37:02 +08:00
```http
PUT /api/alert-notifications/uid/cIBgcSjkk HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
2019-03-29 16:42:38 +08:00
"uid": "new-alert-notification", // optional
2019-03-26 19:37:02 +08:00
"name": "new alert notification", //Required
"type": "email", //Required
"isDefault": false,
"sendReminder": true,
"frequency": "15m",
"settings": {
2019-05-28 22:02:14 +08:00
"addresses": "dev@grafana.com"
2019-03-26 19:37:02 +08:00
}
}
```
2019-12-31 23:30:53 +08:00
**Example response**:
2019-03-26 19:37:02 +08:00
```http
HTTP/1.1 200
Content-Type: application/json
{
"id": 1,
2019-03-29 16:42:38 +08:00
"uid": "new-alert-notification",
2019-03-26 19:37:02 +08:00
"name": "new alert notification",
"type": "email",
"isDefault": false,
"sendReminder": true,
"frequency": "15m",
"settings": {
2019-05-28 22:02:14 +08:00
"addresses": "dev@grafana.com"
2019-03-26 19:37:02 +08:00
},
"created": "2017-01-01 12:34",
"updated": "2017-01-01 12:34"
}
```
## Update notification channel by id
`PUT /api/alert-notifications/:id`
Updates an existing notification channel identified by id.
2019-12-31 23:30:53 +08:00
**Example request**:
2019-03-26 19:37:02 +08:00
```http
PUT /api/alert-notifications/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
"id": 1,
2019-03-29 16:42:38 +08:00
"uid": "new-alert-notification", // optional
2019-03-26 19:37:02 +08:00
"name": "new alert notification", //Required
"type": "email", //Required
"isDefault": false,
"sendReminder": true,
"frequency": "15m",
"settings": {
2019-05-28 22:02:14 +08:00
"addresses": "dev@grafana.com"
2019-03-26 19:37:02 +08:00
}
}
```
2019-12-31 23:30:53 +08:00
**Example response**:
2019-03-26 19:37:02 +08:00
```http
HTTP/1.1 200
Content-Type: application/json
{
"id": 1,
2019-03-29 16:42:38 +08:00
"uid": "new-alert-notification",
2019-03-26 19:37:02 +08:00
"name": "new alert notification",
"type": "email",
"isDefault": false,
"sendReminder": true,
"frequency": "15m",
"settings": {
2019-05-28 22:02:14 +08:00
"addresses": "dev@grafana.com"
2019-03-26 19:37:02 +08:00
},
"created": "2017-01-01 12:34",
"updated": "2017-01-01 12:34"
}
```
## Delete alert notification by uid
`DELETE /api/alert-notifications/uid/:uid`
Deletes an existing notification channel identified by uid.
2019-12-31 23:30:53 +08:00
**Example request**:
2019-03-26 19:37:02 +08:00
```http
DELETE /api/alert-notifications/uid/team-a-email-notifier HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
2019-12-31 23:30:53 +08:00
**Example response**:
2019-03-26 19:37:02 +08:00
```http
HTTP/1.1 200
Content-Type: application/json
{
"message": "Notification deleted"
}
```
## Delete alert notification by id
`DELETE /api/alert-notifications/:id`
Deletes an existing notification channel identified by id.
2019-12-31 23:30:53 +08:00
**Example request**:
2019-03-26 19:37:02 +08:00
```http
DELETE /api/alert-notifications/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
2019-12-31 23:30:53 +08:00
**Example response**:
2019-03-26 19:37:02 +08:00
```http
HTTP/1.1 200
Content-Type: application/json
{
"message": "Notification deleted"
}
```
## Test notification channel
Sends a test notification message for the given notification channel type and settings.
You can find the full list of [supported notifiers ](/alerting/notifications/#all-supported-notifier ) at the alert notifiers page.
`POST /api/alert-notifications/test`
2019-12-31 23:30:53 +08:00
**Example request**:
2019-03-26 19:37:02 +08:00
```http
POST /api/alert-notifications/test HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
"type": "email",
"settings": {
2019-05-28 22:02:14 +08:00
"addresses": "dev@grafana.com"
2019-03-26 19:37:02 +08:00
}
}
```
2019-12-31 23:30:53 +08:00
**Example response**:
2019-03-26 19:37:02 +08:00
```http
HTTP/1.1 200
Content-Type: application/json
{
"message": "Test notification sent"
}
```
