Sign in

v53

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-076771,7565.2 MB
APM agent configuration

Get single agent configuration

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/apm/settings/agent-configuration/view</span></div>

Refer to Spaces for more information.

Retrieve a single agent configuration matching the given service name and environment. You must have read privileges for the APM and User Experience feature in Kibana. If no matching configuration is found, the API returns a 404.

get/api/apm/settings/agent-configuration/view

Query parameters

namestring

Service name

environmentstring

Service environment

Headers

elastic-api-version'2023-10-31' required

The version of the API to use

Response

Successful response

idstring required
@timestampnumber required

Timestamp

agent_namestring

Agent name

applied_by_agentboolean

Applied by agent

etagstring required

etag is sent by the APM agent to indicate the etag of the last successfully applied configuration. If the etag matches an existing configuration its applied_by_agent property will be set to true. Every time a configuration is edited applied_by_agent is reset to false.

settingsAPMUISettingsObject required

Agent configuration settings

Example response

{
  "@timestamp": 1730194190636,
  "applied_by_agent": true,
  "etag": "0bc3b5ebf18fba8163fe4c96f491e3767a358f85",
  "service": {
    "environment": "prod",
    "name": "node"
  }
}