Elastic APM agent configuration APIedit

APM Server exposes API endpoints that allow Elastic APM agents to query the APM Server for configuration changes. More information on this feature is available in APM agent configuration in Kibana.

Agent configuration endpointsedit

Name Endpoint

Agent configuration intake


RUM configuration intake


The Agent configuration endpoints accepts both HTTP GET and HTTP POST requests. If an API keys or Secret token is configured, requests to this endpoint must be authenticated.


service.name is a required query string parameter.


Encode parameters as a JSON object in the body. service.name is a required parameter.

  "service": {
      "name": "test-service",
      "environment": "all"
  "CAPTURE_BODY": "off"
  • Successful - 200
  • APM Server is configured to fetch agent configuration from Elasticsearch but the configuration is invalid - 403
  • APM Server is starting up or Elasticsearch is unreachable - 503
Example requestedit

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

curl -i

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

curl -X POST \
  -H "Authorization: Bearer secret_token" \
  -H 'content-type: application/json' \
  -d '{"service": {"name": "test-service"}}'
Example responseedit
HTTP/1.1 200 OK
Cache-Control: max-age=30, must-revalidate
Content-Type: application/json
Etag: "7b23d63c448a863fa"
Date: Mon, 24 Feb 2020 20:53:07 GMT
Content-Length: 98

    "capture_body": "off",
    "transaction_max_spans": "500",
    "transaction_sample_rate": "0.3"