DOCFix (#6404)
Fix the documention about Health, we were missing ```
thiagoftsm committed
Jul 9, 2019 at 15:09 UTC
a0f30eb2245e1c50c278736c7c8a49d2b9da990f
1 file changed
+5
-2
web/api/health/README.md
+5
-2
@@ -54,7 +54,7 @@ Specifically, the API allows you to:
54
55
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`:
56
57
-```bash
57
+```
58
[registry]
59
# netdata management api key file = /var/lib/netdata/netdata.api.key
60
```
@@ -71,9 +71,11 @@ If you've configured and entered your token correclty, you should see the plain
71
### Disable or silence all alarms
72
73
If all you need is temporarily disable all health checks, then you issue the following before your maintenance period starts:
74
+
75
```
76
curl "http://myserver/api/v1/manage/health?cmd=DISABLE ALL" -H "X-Auth-Token: Mytoken"
77
```
78
+
79
The effect of disabling health checks is that the alarm criteria are not evaluated at all and nothing is written in the alarm log.
80
If you want the health checks to be running but to not receive any notifications during your maintenance period, you can instead use this:
81
@@ -152,6 +154,7 @@ The command `LIST` was added in netdata v1.16.0 and returns a JSON with the curr
154
```
155
156
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`
157
+
158
```
159
json
160
{
@@ -178,7 +181,7 @@ json
181
"type": "DISABLE",
182
"silencers": []
183
}
181
-
184
+```
185
186
### Responses
187