diff options
Diffstat (limited to 'tests/health_mgmtapi/README.md')
| -rw-r--r-- | tests/health_mgmtapi/README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/tests/health_mgmtapi/README.md b/tests/health_mgmtapi/README.md new file mode 100644 index 000000000..c74e03536 --- /dev/null +++ b/tests/health_mgmtapi/README.md @@ -0,0 +1,10 @@ +# Health command API tester + +The directory `tests/health_cmdapi` contains the test script `health-cmdapi-test.sh` for the [health command API](../../web/api/health). + +The script can be executed with options to prepare the system for the tests, run them and restore the system to its previous state. + +It depends on the management API being accessible on localhost:19999 and on the responses to the api/v1/alarms?all requests being functional. +It also requires read access to the management API key that is usually under `/var/lib/netdata/netdata.api.key` (`@varlibdir_POST@/netdata.api.key`). + +[](<>) |