summaryrefslogtreecommitdiffstats
path: root/web/api
diff options
context:
space:
mode:
authorthiagoftsm <thiagoftsm@gmail.com>2019-07-09 15:09:04 +0000
committerGitHub <noreply@github.com>2019-07-09 15:09:04 +0000
commita0f30eb2245e1c50c278736c7c8a49d2b9da990f (patch)
tree8d954a8e630f10cbe02535927479df469d4dc118 /web/api
parent5b57fc441c40959514c4e2d0863be2e6a417e352 (diff)
DOCFix (#6404)
Fix the documention about Health, we were missing ```
Diffstat (limited to 'web/api')
-rw-r--r--web/api/health/README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/web/api/health/README.md b/web/api/health/README.md
index 66a80d5f61..58ef20cb76 100644
--- a/web/api/health/README.md
+++ b/web/api/health/README.md
@@ -54,7 +54,7 @@ Specifically, the API allows you to:
The API is available by default, but it is protected by an `api authorization token` that is stored in the file you will see in the following entry of `http://localhost:19999/netdata.conf`:
-```bash
+```
[registry]
# netdata management api key file = /var/lib/netdata/netdata.api.key
```
@@ -71,9 +71,11 @@ If you've configured and entered your token correclty, you should see the plain
### Disable or silence all alarms
If all you need is temporarily disable all health checks, then you issue the following before your maintenance period starts:
+
```
curl "http://myserver/api/v1/manage/health?cmd=DISABLE ALL" -H "X-Auth-Token: Mytoken"
```
+
The effect of disabling health checks is that the alarm criteria are not evaluated at all and nothing is written in the alarm log.
If you want the health checks to be running but to not receive any notifications during your maintenance period, you can instead use this:
@@ -152,6 +154,7 @@ The command `LIST` was added in netdata v1.16.0 and returns a JSON with the curr
```
As an example, the following response shows that we have two silencers configured, one for an alarm called `samplealarm` and one for alarms with context `random` on host `myhost`
+
```
json
{
@@ -178,7 +181,7 @@ json
"type": "DISABLE",
"silencers": []
}
-
+```
### Responses