From 027646587613443a033b309e82aee924fea3b516 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20=C5=A0trauch?= Date: Sat, 4 Sep 2021 22:18:50 +0200 Subject: [PATCH] README update --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index dd8d85e..60cdf7b 100644 --- a/README.md +++ b/README.md @@ -142,13 +142,15 @@ At least one prometheus label has to be set to export the monitoring service in So far the REST API is super simple and it has only two endpoints: - GET / # Same as /v1/discoveries - GET /v1/discovery # Returns current local discovery packet - GET /v1/discoveries # Returns list of all discovered servers and their labels. - GET /v1/discoveries?labels=LABELS # output will be filtered based on one or multiple labels separated by comma - GET /v1/prometheus/:name # Generates output for Prometheus's SD config, name is group of the monitoring services described above. - POST /v1/labels # Add runtime labels that will persist over daemon restarts. Labels should be in the body of the request, one line per one label. - DELETE /v1/labels # Delete runtime labels. One label per line. Can't affect the labels from environment variables or labels added from the LabelPath. +``` +GET / # Same as /v1/discoveries +GET /v1/discovery # Returns current local discovery packet +GET /v1/discoveries # Returns list of all discovered servers and their labels. +GET /v1/discoveries?labels=LABELS # output will be filtered based on one or multiple labels separated by comma +GET /v1/prometheus/:name # Generates output for Prometheus's SD config, name is group of the monitoring services described above. +POST /v1/labels # Add runtime labels that will persist over daemon restarts. Labels should be in the body of the request, one line per one label. +DELETE /v1/labels # Delete runtime labels. One label per line. Can't affect the labels from environment variables or labels added from the LabelPath. +``` If there is an error the error message is returned as plain text.