Skip to content

Update api-keys.asciidoc - API key prerequisites #21026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 8, 2020
Merged

Update api-keys.asciidoc - API key prerequisites #21026

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f114ce
Update api-keys.asciidoc - API key prerequisites
rwaight Sep 8, 2020
7a98f2e
Update libbeat/docs/security/api-keys.asciidoc
rwaight Sep 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions libbeat/docs/security/api-keys.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ API key. For different clusters, you need to use an API key per cluster.
NOTE: For security reasons, we recommend using a unique API key per {beatname_uc} instance.
You can create as many API keys per user as necessary.

IMPORTANT: Review <<feature-roles>> before creating API keys for {beatname_uc}.

[float]
[[beats-api-key-publish]]
=== Create an API key for publishing
Expand Down Expand Up @@ -41,6 +43,8 @@ POST /_security/api_key
<1> Name of the API key
<2> Granted privileges, see <<feature-roles>>

NOTE: See <<privileges-to-publish-events>> for the list of privileges required to publish events.

The return value will look something like this:

[source,console-result,subs="attributes,callouts"]
Expand Down Expand Up @@ -89,6 +93,8 @@ POST /_security/api_key
<1> Name of the API key
<2> Granted privileges, see <<feature-roles>>

NOTE: See <<privileges-to-publish-monitoring>> for the list of privileges required to send monitoring data.

The return value will look something like this:

[source,console-result,subs="attributes,callouts"]
Expand Down