Skip to content

Update EDOT collector auth snippet #487

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
Nov 19, 2025
Merged

Update EDOT collector auth snippet #487

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9658721
Update EDOT collector auth snippet
alexandra5000 Nov 13, 2025
ea5e23a
Update API key request
alexandra5000 Nov 18, 2025
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
47 changes: 44 additions & 3 deletions docs/reference/central-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,51 @@

You need a valid {{es}} API key to authenticate to the {{es}} endpoint.

::::{include} _snippets/retrieve-credentials.md
::::
:::::

:::::{step} Create an Elasticsearch API key for central configuration

Create an API key with the `config_agent:read` privilege. This API key will be used by EDOT SDKs and validated by the Collector.

Check notice on line 72 in docs/reference/central-configuration.md

View workflow job for this annotation

GitHub Actions / vale 

Elastic.Passive: In general, use active voice instead of passive voice ('be used').

Check notice on line 72 in docs/reference/central-configuration.md

View workflow job for this annotation

GitHub Actions / vale 

Elastic.FutureTense: 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now.

Use the following API request to generate the key:

Make sure the API key has `config_agent:read` permissions and resources set to `-`.
```json
POST /_security/api_key
{
"name": "apmconfig-opamp-test-sdk",
"metadata": {
"application": "apm"
},
"role_descriptors": {
"apm": {
"cluster": [],
"indices": [],
"applications": [
{
"application": "apm",
"privileges": [
"config_agent:read"
],
"resources": [
"*"
]
}
],
"run_as": [],
"metadata": {}
}
}
}
```

::::{note}
The EDOT Collector doesn't store or embed the {{es}} API key.

Each EDOT SDK must send its own API key in the `Authorization` header (for example: `Authorization: ApiKey <Base64(id:key)>`).

The `apikeyauth` extension only validates this API key against {{es}}, ensuring it includes the `config_agent:read` privilege with `resources: ["*"]`.
::::
:::::

::::{dropdown} Example JSON payload
```json
Expand Down
Loading