Agent configuration API

APM Server exposes an API endpoint that allows agents to query the server for configuration changes. More information on this feature is available in APM Agent configuration in Kibana.

Send an HTTP GET request to the agent configuration endpoint. service.name is a required query string parameter.

http(s)://{hostname}:{port}/config/v1/agents?service.name=SERVICE_NAME

If a secret_token has been configured, it should also apply to this endpoint.

Example Agent configuration request including the service name "test-service":

curl -i http://127.0.0.1:8200/config/v1/agents?service.name=test-service

A sample response to the above curl request:

HTTP/1.1 200 OK
Cache-Control: max-age=30, must-revalidate
Content-Type: application/json
Etag: "5"
Date: Fri, 05 Jul 2019 21:47:35 GMT
Content-Length: 30

{
  "sampling_rate": "0.12"
}