v53

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

APM agent configuration

Lookup single agent configuration

Spaces method and path for this operation:

<div><span class="operation-verb post">post</span> <span class="operation-path">/s/{space_id}/api/apm/settings/agent-configuration/search</span></div>

Refer to Spaces for more information.

DEPRECATED: This endpoint is intended for internal use by APM agents to fetch their configuration and mark it as applied. Do not use for new integrations. It searches for a single agent configuration matching the given service, and optionally updates the applied_by_agent field when the provided etag matches the current configuration.

post/api/apm/settings/agent-configuration/search

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

errorstring

If provided, the agent configuration will be marked as error and applied_by_agent will be set to false. This is useful for cases where the agent configuration was not applied successfully.

etagstring

If etags match then applied_by_agent field will be set to true

mark_as_applied_by_agentboolean

markAsAppliedByAgent=true means "force setting it to true regardless of etag". This is needed for Jaeger agent that doesn't have etags

Example request

{
  "etag": "0bc3b5ebf18fba8163fe4c96f491e3767a358f85",
  "service": {
    "environment": "prod",
    "name": "node"
  }
}

Response

Successful response

_idstring

Identifier

_indexstring

Index

_scorenumber

Score

Example response

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