Elastic APM agent configuration API

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 endpoints

Name	Endpoint
Agent configuration intake	/config/v1/agents
RUM configuration intake	/config/v1/rum/agents

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.

HTTP GET

service.name is a required query string parameter.

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

		

HTTP POST

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

			http(s)://{hostname}:{port}/config/v1/agents
{
  "service": {
      "name": "test-service",
      "environment": "all"
  },
  "CAPTURE_BODY": "off"
}

		

Responses

• 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 request

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

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

		

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

			curl -X POST http://127.0.0.1:8200/config/v1/agents \
  -H "Authorization: Bearer secret_token" \
  -H 'content-type: application/json' \
  -d '{"service": {"name": "test-service"}}'

		

Example response

			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"
}