- Observability: other versions:
- Get started
- What is Elastic Observability?
- What’s new in 8.17
- Quickstart: Monitor hosts with Elastic Agent
- Quickstart: Monitor your Kubernetes cluster with Elastic Agent
- Quickstart: Monitor hosts with OpenTelemetry
- Quickstart: Unified Kubernetes Observability with Elastic Distributions of OpenTelemetry (EDOT)
- Quickstart: Collect data with AWS Firehose
- Add data from Splunk
- Applications and services
- Application performance monitoring (APM)
- Get started
- Learn about data types
- Collect application data
- View and analyze data
- Act on data
- Use APM securely
- Manage storage
- Configure APM Server
- Monitor APM Server
- APM APIs
- Troubleshooting
- Upgrade
- Release notes
- Known issues
- Synthetic monitoring
- Get started
- Scripting browser monitors
- Configure lightweight monitors
- Manage monitors
- Work with params and secrets
- Analyze monitor data
- Monitor resources on private networks
- Use the CLI
- Configure projects
- Multi-factor Authentication
- Configure Synthetics settings
- Grant users access to secured resources
- Manage data retention
- Use Synthetics with traffic filters
- Migrate from the Elastic Synthetics integration
- Scale and architect a deployment
- Synthetics support matrix
- Synthetics Encryption and Security
- Troubleshooting
- Real user monitoring
- Uptime monitoring (deprecated)
- Tutorial: Monitor a Java application
- Application performance monitoring (APM)
- CI/CD
- Cloud
- Infrastructure and hosts
- Logs
- Troubleshooting
- Incident management
- Data set quality
- Observability AI Assistant
- Reference
Elastic APM agent configuration API
editElastic APM agent configuration API
editAPM 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
editName | 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.
HTTP GET
editservice.name
is a required query string parameter.
http(s)://{hostname}:{port}/config/v1/agents?service.name=SERVICE_NAME
HTTP POST
editEncode 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
edit-
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
editExample 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
editHTTP/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" }