Lookup single agent configuration

deprecated

Base URL: https://{kibana_url}

POST /api/apm/settings/agent-configuration/search
POST /s/{space_id}/api/apm/settings/agent-configuration/search

Refer to Spaces for more information.

Warning

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.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Header parameters

Request body

Responses

Successful response

application/json

Bad Request response

application/json

Unauthorized response

application/json

Not found response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Run POST /api/apm/settings/agent-configuration/search to search configuration details.

Console Kibana Dev Tools

POST kbn:/api/apm/settings/agent-configuration/search
{
  "etag": "1e58c178efeebae15c25c539da740d21dee422fc",
  "service": {
    "environment": "production",
    "name": "frontend"
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/apm/settings/agent-configuration/search" \
  -H "elastic-api-version: 2023-10-31" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "etag": "1e58c178efeebae15c25c539da740d21dee422fc",
    "service": {
      "environment": "production",
      "name": "frontend"
    }
  }'

Generated from the API spec

Response

An example of a successful response from POST /api/apm/settings/agent-configuration/search.

{
  "_id": "CIaqXXABmQCdPphWj8EJ",
  "_index": ".apm-agent-configuration",
  "_score": 2,
  "_source": {
    "@timestamp": 1582031336265,
    "agent_name": "nodejs",
    "applied_by_agent": false,
    "etag": "5080ed25785b7b19f32713681e79f46996801a5b",
    "service": {
      "name": "frontend"
    },
    "settings": {
      "transaction_sample_rate": "1"
    }
  }
}

{
  "error": "Bad Request",
  "message": "[request body]: expected value of type [string] but got [undefined]",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "[security_exception]: missing authentication credentials for REST request",
  "statusCode": 401
}

{
  "error": "Not Found",
  "message": "Not Found",
  "statusCode": 404
}

Authentication

Header parameters

Request body { }

Responses

Request body