Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
N
nexpie-grafana-theme
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Registry
Registry
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Kornkitt Poolsup
nexpie-grafana-theme
Commits
9c246ba3
Commit
9c246ba3
authored
Apr 12, 2017
by
Torkel Ödegaard
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: fixed http docs for alert notifications, fixes #8105
parent
20ac8bf8
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
15 additions
and
15 deletions
+15
-15
docs/sources/http_api/alerting.md
+15
-15
No files found.
docs/sources/http_api/alerting.md
View file @
9c246ba3
...
...
@@ -12,8 +12,8 @@ parent = "http_api"
# Alerting API
You can use the Alerting API to get information about alerts and their states but this API cannot be used to modify the alert.
To create new alerts or modify them you need to update the dashboard json that contains the alerts.
You can use the Alerting API to get information about alerts and their states but this API cannot be used to modify the alert.
To create new alerts or modify them you need to update the dashboard json that contains the alerts.
This API can also be used to create, update and delete alert notifications.
...
...
@@ -115,7 +115,7 @@ This API can also be used to create, update and delete alert notifications.
HTTP/1.1 200
Content-Type: application/json
{
"id": 1,
"name": "Team A",
...
...
@@ -127,11 +127,11 @@ This API can also be used to create, update and delete alert notifications.
## Create alert notification
`POST /api/alert
s
-notifications`
`POST /api/alert-notifications`
**Example Request**
:
POST /api/alert
s
-notifications HTTP/1.1
POST /api/alert-notifications HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
...
...
@@ -144,29 +144,29 @@ This API can also be used to create, update and delete alert notifications.
"addresses": "carl@grafana.com;dev@grafana.com"
}
}
**Example Response**
:
HTTP/1.1 200
Content-Type: application/json
{
"id": 1,
"id": 1,
"name": "new alert notification",
"type": "email",
"isDefault": false,
"settings": { addresses: "carl@grafana.com;dev@grafana.com"} }
"created": "2017-01-01 12:34",
"created": "2017-01-01 12:34",
"updated": "2017-01-01 12:34"
}
## Update alert notification
`PUT /api/alert
s
-notifications/1`
`PUT /api/alert-notifications/1`
**Example Request**
:
PUT /api/alert
s
-notifications/1 HTTP/1.1
PUT /api/alert-notifications/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
...
...
@@ -176,29 +176,29 @@ This API can also be used to create, update and delete alert notifications.
"name": "new alert notification", //Required
"type": "email", //Required
"isDefault": false,
"settings": {
"settings": {
"addresses: "carl@grafana.com;dev@grafana.com"
}
}
**Example Response**
:
HTTP/1.1 200
Content-Type: application/json
{
"id": 1,
"id": 1,
"name": "new alert notification",
"type": "email",
"isDefault": false,
"settings": { addresses: "carl@grafana.com;dev@grafana.com"} }
"created": "2017-01-01 12:34",
"created": "2017-01-01 12:34",
"updated": "2017-01-01 12:34"
}
## Delete alert notification
`DELETE /api/alert
s
-notifications/:notificationId`
`DELETE /api/alert-notifications/:notificationId`
**Example Request**
:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment