From d1bda9ce1fc8cebf4d17dcce57d649300531e806 Mon Sep 17 00:00:00 2001 From: PandaWawawa Date: Thu, 8 Oct 2015 17:44:43 +0200 Subject: [PATCH] Doc added --- doc/API/API-Docs.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/API/API-Docs.md b/doc/API/API-Docs.md index 39bb0bcd8..17b34e753 100644 --- a/doc/API/API-Docs.md +++ b/doc/API/API-Docs.md @@ -25,6 +25,7 @@ - [`alerts`](#api-alerts) - [`get_alert`](#api-route-12) - [`ack_alert`](#api-route-13) + - [`unmute_alert`](#api-route-24) - [`list_alerts`](#api-route-14) - [`rules`](#api-rules) - [`get_alert_rule`](#api-route-15) @@ -591,6 +592,33 @@ Output: } ``` +### Function: `unmute_alert` [`top`](#top) + +Unmute an alert + +Route: /api/v0/alerts/unmute/:id + +- id is the alert id, you can obtain a list of alert ids from [`list_alerts`](#api-route-14). + +Input: + + - + +Example: +```curl +curl -X PUT -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/alerts/unmute/1 +``` + +Output: +```text +{ + "status": "ok", + "err-msg": "", + "message": "Alert has been unmuted" +} +``` + + ### Function: `list_alerts` [`top`](#top) List all alerts