summaryrefslogtreecommitdiffstats
path: root/tests/health_mgmtapi/README.md
blob: e19b612a5267156f044159424f8dccbb278e4df8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!--
title: "Health command API tester"
custom_edit_url: https://github.com/netdata/netdata/edit/master/tests/health_mgmtapi/README.md
-->

# 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/README.md).

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`).