Get a list of agent configurations

Base URL: https://{kibana_url}

GET /api/apm/settings/agent-configuration
GET /s/{space_id}/api/apm/settings/agent-configuration

Auth

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

Responses

Successful response

application/json

configurations object[]: Agent configuration

Bad Request response

application/json

Unauthorized response

application/json

Not found response

application/json

View as Markdown

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

{
  "configurations": [
    {
      "@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