- Observability: other versions:
- What is Elastic Observability?
- What’s new in 8.14
- Get started
- Observability AI Assistant
- Application performance monitoring (APM)
- Self manage APM Server
- Data Model
- Features
- Navigate the APM UI
- Perform common tasks in the APM UI
- Configure APM agents with central config
- Control access to APM data
- Create an alert
- Create and upload source maps (RUM)
- Create custom links
- Filter data
- Find transaction latency and failure correlations
- Identify deployment details for APM agents
- Integrate with machine learning
- Explore mobile sessions with Discover
- Observe Lambda functions
- Query your data
- Storage Explorer
- Track deployments with annotations
- OpenTelemetry integration
- Manage storage
- Configure
- Advanced setup
- Secure communication
- Monitor
- APM Server API
- APM UI API
- Troubleshoot
- Upgrade
- Release notes
- Known issues
- Log monitoring
- Infrastructure monitoring
- AWS monitoring
- Azure monitoring
- 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
- 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
- Uptime monitoring
- Real user monitoring
- Universal Profiling
- Alerting
- Service-level objectives (SLOs)
- Cases
- CI/CD observability
- Troubleshooting
- Fields reference
- Tutorials
Agent Configuration API
editAgent Configuration API
editThe APM agent configuration API allows you to fine-tune your APM agent configuration, without needing to redeploy your application.
The following APM agent configuration APIs are available:
- Create or update configuration to create or update an APM agent configuration
- Delete configuration to delete an APM agent configuration.
- List configuration to list all APM agent configurations.
- Search configuration to search for an APM agent configuration.
How to use APM APIs
editExpand for required headers, privileges, and usage details
Interact with APM APIs using cURL or another API tool. All APM APIs are Kibana APIs, not Elasticsearch APIs; because of this, the Kibana dev tools console cannot be used to interact with APM APIs.
For all APM APIs, you must use a request header.
Supported headers are Authorization, kbn-xsrf, and Content-Type.
-
Authorization: ApiKey {credentials} -
Kibana supports token-based authentication with the Elasticsearch API key service. The API key returned by the Elasticsearch create API key API can be used by sending a request with an
Authorizationheader that has a value ofApiKeyfollowed by the{credentials}, where{credentials}is the base64 encoding ofidandapi_keyjoined by a colon.Alternatively, you can create a user and use their username and password to authenticate API access:
-u $USER:$PASSWORD.Whether using
Authorization: ApiKey {credentials}, or-u $USER:$PASSWORD, users interacting with APM APIs must have sufficient privileges. -
kbn-xsrf: true -
By default, you must use
kbn-xsrffor all API calls, except in the following scenarios:-
The API endpoint uses the
GETorHEADoperations -
The path is allowed using the
server.xsrf.allowlistsetting -
XSRF protections are disabled using the
server.xsrf.disableProtectionsetting
-
The API endpoint uses the
-
Content-Type: application/json -
Applicable only when you send a payload in the API request.
Kibana API requests and responses use JSON.
Typically, if you include the
kbn-xsrfheader, you must also include theContent-Typeheader.
On this page