Lookup single agent configuration | Kibana Serverless API documentation

Lookup single agent configuration Deprecated

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

Spaces method and path for this operation:

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

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.

Headers

elastic-api-version string Required

The version of the API to use

Value is 2023-10-31. Default value is 2023-10-31.
kbn-xsrf string Required

A required header to protect against CSRF attacks

application/json

Body Required

error string

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.
etag string

If etags match then applied_by_agent field will be set to true
mark_as_applied_by_agent boolean

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

Service
Hide service attributes Show service attributes object
- environment string
  
  The environment of the service.
- name string
  
  The name of the service.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- _id string
  
  Identifier
- _index string
  
  Index
- _score number
  
  Score
- _source object
  
  Agent configuration
  
  Hide _source attributes Show _source attributes object
  
  @timestamp number Required
  
  Timestamp
  
  agent_name string
  
  Agent name
  
  applied_by_agent boolean
  
  Applied by agent
  
  etag string 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.
  
  service object Required
  
  Service
  
  Hide service attributes Show service attributes object
  
  environment string
  
  The environment of the service.
  
  name string
  
  The name of the service.
  
  settings object Required
  
  Agent configuration settings
  
  Hide settings attribute Show settings attribute object
  
  * string Additional properties
400 application/json

Bad Request response
Hide response attributes Show response attributes object
- error string
  
  Error type
- message string
  
  Error message
- statusCode number
  
  Error status code
401 application/json

Unauthorized response
Hide response attributes Show response attributes object
- error string
  
  Error type
- message string
  
  Error message
- statusCode number
  
  Error status code
404 application/json

Not found response
Hide response attributes Show response attributes object
- error string
  
  Error type
- message string
  
  Error message
- statusCode number
  
  Error status code

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

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

Request example

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

{
  "etag": "1e58c178efeebae15c25c539da740d21dee422fc",
  "service": {
    "environment": "production",
    "name": "frontend"
  }
}

Response examples (200)

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"
    }
  }
}