Server Information APIedit

This documentation refers to the API of the standalone (legacy) APM Server. This method of running APM Server will be deprecated and removed in a future release. Please consider upgrading to Fleet and the APM integration. If you’ve already upgraded, see Server information API.

The APM Server exposes an API endpoint to query general server information. This lightweight endpoint is useful as a server up/down healthcheck.

Server Information endpointedit

Send an HTTP GET request to the server information endpoint:

http(s)://{hostname}:{port}/

This endpoint always returns an HTTP 200.

If an API keys or Secret token is set, only requests including authentication will receive server details.

Set the Accept header set to text/plain to move the server information to the root level of the response, removing ok.

Exampleedit

Example server information request:

curl http://127.0.0.1:8200/

{
  "ok": {
    "build_date": "2018-07-27T18:49:58Z",
    "build_sha": "bc4d9a286a65b4283c2462404add86a26be61dca",
    "version": "7.0.0-alpha1"
  }
}