Browse Source

docs(http): adds info about mass pausing alerts

bergquist 9 years ago
parent
commit
0c857e0ed8
1 changed files with 17 additions and 0 deletions
  1. 17 0
      docs/sources/http_api/admin.md

+ 17 - 0
docs/sources/http_api/admin.md

@@ -275,3 +275,20 @@ Change password for specific user
     Content-Type: application/json
 
     {message: "User deleted"}
+
+## Pause all alerts
+
+`DELETE /api/admin/pause-all-alerts`
+
+**Example Request**:
+
+    DELETE /api/admin/pause-all-alerts HTTP/1.1
+    Accept: application/json
+    Content-Type: application/json
+
+**Example Response**:
+
+    HTTP/1.1 200
+    Content-Type: application/json
+
+    {state: "new state", message: "alerts pause/un paused", "alertsAffected": 100}