Get a list of agent configurations

Base URL: https://{kibana_url}

GET /api/apm/settings/agent-configuration

Auth

Retrieve all agent configurations. You must have read privileges for the APM and User Experience feature in Kibana. If agent configuration is not available on the current deployment, the API returns a 404.

Header parameters

elastic-api-version enum · default: 2023-10-31 required: The version of the API to use; Values: 2023-10-31

Responses

Successful response

application/json

configurations object[]: Agent configuration

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

Console Kibana Dev Tools

GET kbn:/api/apm/settings/agent-configuration

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/apm/settings/agent-configuration" \
  -H "elastic-api-version: 2023-10-31" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

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

[
  {
    "@timestamp": 1581934104843,
    "agent_name": "go",
    "applied_by_agent": false,
    "etag": "1e58c178efeebae15c25c539da740d21dee422fc",
    "service": {
      "environment": "production",
      "name": "opbeans-go"
    },
    "settings": {
      "capture_body": "off",
      "transaction_max_spans": "200",
      "transaction_sample_rate": "1"
    }
  },
  {
    "@timestamp": 1581934111727,
    "agent_name": "go",
    "applied_by_agent": false,
    "etag": "3eed916d3db434d9fb7f039daa681c7a04539a64",
    "service": {
      "name": "opbeans-go"
    },
    "settings": {
      "capture_body": "off",
      "transaction_max_spans": "300",
      "transaction_sample_rate": "1"
    }
  },
  {
    "@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
}