Lookup single agent configuration

Base URL: https://{kibana_url}

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

Auth

This endpoint allows to search for single agent configuration and update 'applied_by_agent' field.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Header parameters

elastic-api-version enum · default: 2023-10-31 required: The version of the API to use; Values: 2023-10-31
kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

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

Responses

Successful response

application/json

_id string: Identifier
_index string: Index
_score number: Score
_source object: Agent configuration

Bad Request response

application/json

error string: Error type
message string: Error message
statusCode number: Error status code

Unauthorized response

application/json

error string: Error type
message string: Error message
statusCode number: Error status code

Not found response

application/json

error string: Error type
message string: Error message
statusCode number: Error status code

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/apm/settings/agent-configuration/search
{
  "service": {}
}

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 '{
    "service": {}
  }'

Generated from the API spec

Response

{
  "_id": "string",
  "_index": "string",
  "_score": 0,
  "_source": {
    "@timestamp": 1730194190636,
    "agent_name": "string",
    "applied_by_agent": true,
    "etag": "0bc3b5ebf18fba8163fe4c96f491e3767a358f85",
    "service": {
      "environment": "prod",
      "name": "node"
    },
    "settings": {
      "key": "string"
    }
  }
}

Generated from the API spec

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

Generated from the API spec

{
  "error": "Unauthorized",
  "message": "string",
  "statusCode": 401
}

Generated from the API spec

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

Generated from the API spec