Skip to content
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

apm-server: Remove server information endpoint POST / support #647

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

apm-server: Remove server information endpoint POST / support #647

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c9ba9e2
apm-server: Remove POST from server information API docs
carsonip Mar 4, 2025
ef93d14
Add changelog to breaking change
carsonip Mar 4, 2025
76c9c15
Uncomment breaking change
carsonip Mar 5, 2025
de167ef
Remove backticks as they are not supported in dropdown subject
carsonip Mar 5, 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
9 changes: 8 additions & 1 deletion release-notes/breaking-changes/elastic-apm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,11 @@ To learn how to upgrade, check out <uprade docs>.
% For more information, check [PR #](PR link).
% **Impact**<br> Impact of the breaking change.
% **Action**<br> Steps for mitigating deprecation impact.
% ::::
% ::::

% ::::{dropdown} Change server information endpoint `/` to only accept GET and HEAD requests
% This will surface any agent misconfiguration causing data to be sent to `/` instead of the correct endpoint, e.g. `/v1/traces` for OTLP/HTTP.
% For more information, check [PR #15976](https://github.com/elastic/apm-server/pull/15976).
% **Impact**<br> Any methods other than GET and HEAD to `/` will return HTTP 405 Method Not Allowed.
% **Action**<br> Update any existing usage of e.g. `POST /` to `GET /`.
% ::::
10 changes: 5 additions & 5 deletions solutions/observability/apps/apm-server-information-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ This is the server information endpoint:
http(s)://{hostname}:{port}/
```

Sending an `HTTP GET` or `HTTP POST` request to the server information endpoint will return an HTTP 200, indicating that the server is up.
Sending an `HTTP GET` request to the server information endpoint will return an HTTP 200, indicating that the server is up.

To configure authenticated access to the APM server, the instructions at [APM API key](api-keys.md) or [APM Secret Token](secret-token.md), must be followed to configure the correct permissions for APM access.

If an [API keys](api-keys.md) or a [Secret token](secret-token.md) is passed along with the `HTTP GET` or `HTTP POST` request, in addition to an HTTP 200, the response payload will include some information about the APM server.
If an [API keys](api-keys.md) or a [Secret token](secret-token.md) is passed along with the `HTTP GET` request, in addition to an HTTP 200, the response payload will include some information about the APM server.


### Example: GET, without credentials [apm-api-info-example-get-without-credentials]
Expand Down Expand Up @@ -48,12 +48,12 @@ curl --verbose -X GET http://127.0.0.1:8200
```


### Example: POST, with secret token [apm-api-info-example-post-with-secret-token]
### Example: GET, with secret token [apm-api-info-example-get-with-secret-token]

Example APM Server information request with POST, with a [Secret token](secret-token.md):
Example APM Server information request with GET, with a [Secret token](secret-token.md):

```sh
curl -X POST http://127.0.0.1:8200/ \
curl -X GET http://127.0.0.1:8200/ \
-H "Authorization: Bearer secret_token"

{
Expand Down
Loading