APM agent configuration
Create or update agent configuration
Spaces method and path for this operation:
<div><span class="operation-verb put">put</span> <span class="operation-path">/s/{space_id}/api/apm/settings/agent-configuration</span></div>Refer to Spaces for more information.
Create or update an agent configuration. You must have all privileges for the APM and User Experience feature in Kibana. When updating an existing configuration, the ?overwrite=true query parameter is required. If the configuration already exists and overwrite is not set to true, the API returns a 400 error. When successful and Fleet is enabled, APM package policies are synchronized accordingly.
put/api/apm/settings/agent-configuration
Query parameters
overwriteboolean
If the config exists ?overwrite=true is required
Headers
elastic-api-version'2023-10-31' required
The version of the API to use
kbn-xsrfstring required
Example:true
A required header to protect against CSRF attacks
Request body
Example request
{
"service": {
"environment": "prod",
"name": "node"
}
}Response
Successful response
object required
The response body is intentionally empty for this endpoint.