From 0c1e447d681b5bd0e1bdb2e109d86a47dc962995 Mon Sep 17 00:00:00 2001 From: Julien Pivotto Date: Mon, 30 Oct 2023 16:08:11 +0100 Subject: [PATCH] Exclude alerts: improve documentation (#13046) Signed-off-by: Julien Pivotto --- docs/querying/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/querying/api.md b/docs/querying/api.md index 3a5d6cd8d..a268b1cc9 100644 --- a/docs/querying/api.md +++ b/docs/querying/api.md @@ -679,7 +679,7 @@ URL query parameters: - `rule_name[]=`: only return rules with the given rule name. If the parameter is repeated, rules with any of the provided names are returned. If we've filtered out all the rules of a group, the group is not returned. When the parameter is absent or empty, no filtering is done. - `rule_group[]=`: only return rules with the given rule group name. If the parameter is repeated, rules with any of the provided rule group names are returned. When the parameter is absent or empty, no filtering is done. - `file[]=`: only return rules with the given filepath. If the parameter is repeated, rules with any of the provided filepaths are returned. When the parameter is absent or empty, no filtering is done. -- `exclude_alerts`: only return rules without active alerts. When this parameter is absent or empty, no filtering is done. +- `exclude_alerts=`: only return rules, do not return active alerts. ```json $ curl http://localhost:9090/api/v1/rules