Browse Source

docs: adds docs for pausing all alerts

bergquist 8 years ago
parent
commit
ca940c2ae5
1 changed files with 31 additions and 0 deletions
  1. 31 0
      docs/sources/http_api/alerting.md

+ 31 - 0
docs/sources/http_api/alerting.md

@@ -133,6 +133,37 @@ Content-Type: application/json
 }
 ```
 
+## Pause all alerts
+
+`POST /api/admin/pause-all-alerts`
+
+```http
+POST /api/admin/pause-all-alerts HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+
+{
+  "paused": true
+}
+```
+
+JSON Body Schema:
+
+- **paused** – Can be `true` or `false`. True to pause an alert. False to unpause an alert.
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+{
+  "state":   "Paused",
+  "message": "alert paused",
+  "alertsAffected": 1
+}
+```
+
 ## Get alert notifications
 
 `GET /api/alert-notifications`