From ca940c2ae5293c600981860158390b57eed607e7 Mon Sep 17 00:00:00 2001 From: bergquist Date: Wed, 22 Nov 2017 09:30:03 +0100 Subject: [PATCH] docs: adds docs for pausing all alerts --- docs/sources/http_api/alerting.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/docs/sources/http_api/alerting.md b/docs/sources/http_api/alerting.md index c5172c64203..e66218bb066 100644 --- a/docs/sources/http_api/alerting.md +++ b/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`