From 4b16a4fcb3f700acf9348cf7639bf417fdb6bc19 Mon Sep 17 00:00:00 2001 From: "Devin W. Hurley" Date: Thu, 21 Oct 2021 16:25:12 -0400 Subject: [PATCH] [Docs] [Security Platform] adds warning for basic auth only (#1171) * adds warning for basic auth only * fixes link references * use ref not kibana-ref, maybe? * use kibana-ref Co-authored-by: Elastic Machine Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com> --- docs/detections/api/rules/rules-api-bulk-actions.asciidoc | 4 ++++ docs/detections/api/rules/rules-api-create.asciidoc | 2 ++ docs/detections/api/rules/rules-api-import.asciidoc | 2 ++ docs/detections/api/rules/rules-api-update.asciidoc | 2 ++ 4 files changed, 10 insertions(+) diff --git a/docs/detections/api/rules/rules-api-bulk-actions.asciidoc b/docs/detections/api/rules/rules-api-bulk-actions.asciidoc index acdd74b94a..6abbf9a16e 100644 --- a/docs/detections/api/rules/rules-api-bulk-actions.asciidoc +++ b/docs/detections/api/rules/rules-api-bulk-actions.asciidoc @@ -8,6 +8,8 @@ NOTE: Console supports only {es} APIs and doesn't allow interactions with {kib} ==== Bulk create +WARNING: This API supports {kibana-ref}/api.html#token-api-authentication[Token-based authentication] only. + Creates new rules. ===== Request URL @@ -117,6 +119,8 @@ A JSON array containing the deleted rules. ==== Bulk update +WARNING: This API supports {kibana-ref}/api.html#token-api-authentication[Token-based authentication] only. + Updates multiple rules. You can use `PUT` or `PATCH` methods to bulk update rules, where: diff --git a/docs/detections/api/rules/rules-api-create.asciidoc b/docs/detections/api/rules/rules-api-create.asciidoc index c15e998567..6478adb40e 100644 --- a/docs/detections/api/rules/rules-api-create.asciidoc +++ b/docs/detections/api/rules/rules-api-create.asciidoc @@ -1,6 +1,8 @@ [[rules-api-create]] === Create rule +WARNING: This API supports {kibana-ref}/api.html#token-api-authentication[Token-based authentication] only. + Creates a new detection rule. NOTE: The {kib} Console supports only Elasticsearch APIs. Console doesn't allow interactions with {kib} APIs. You must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console]. diff --git a/docs/detections/api/rules/rules-api-import.asciidoc b/docs/detections/api/rules/rules-api-import.asciidoc index f55853191a..83e201cf4b 100644 --- a/docs/detections/api/rules/rules-api-import.asciidoc +++ b/docs/detections/api/rules/rules-api-import.asciidoc @@ -1,6 +1,8 @@ [[rules-api-import]] === Import rules +WARNING: This API supports {kibana-ref}/api.html#token-api-authentication[Token-based authentication] only. + Imports rules from an ndjson file. NOTE: The {kib} Console supports only Elasticsearch APIs. Console doesn't allow interactions with {kib} APIs. You must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console]. diff --git a/docs/detections/api/rules/rules-api-update.asciidoc b/docs/detections/api/rules/rules-api-update.asciidoc index 3f260cc728..db91f1f333 100644 --- a/docs/detections/api/rules/rules-api-update.asciidoc +++ b/docs/detections/api/rules/rules-api-update.asciidoc @@ -1,6 +1,8 @@ [[rules-api-update]] === Update rule +WARNING: This API supports {kibana-ref}/api.html#token-api-authentication[Token-based authentication] only. + Updates an existing detection rule. NOTE: The {kib} Console supports only Elasticsearch APIs. Console doesn't allow interactions with {kib} APIs. You must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].