Get single agent configuration

Server: https://{kibana_url}

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

Refer to Spaces for more information.

Retrieve a single agent configuration matching the given service name and environment. You must have read privileges for the APM and User Experience feature in Kibana. If no matching configuration is found, the API returns a 404.

Query Parameters

Responses

Successful response

application/json

Bad Request response

application/json

Unauthorized response

application/json

Not found response

application/json

Examples

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

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /api/apm/settings/agent-configuration/view

curl Shell

curl -X GET "https://{kibana_url}/api/apm/settings/agent-configuration/view" \
  -H "elastic-api-version: string"

Response

{
  "@timestamp": 1582031336265,
  "agent_name": "nodejs",
  "applied_by_agent": true,
  "etag": "5080ed25785b7b19f32713681e79f46996801a5b",
  "id": "CIaqXXABmQCdPphWj8EJ",
  "service": {
    "environment": "production",
    "name": "frontend"
  },
  "settings": {
    "capture_body": "off",
    "transaction_max_spans": "500",
    "transaction_sample_rate": "0.4"
  }
}

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

Query Parameters { name , environment , }

Responses

Query Parameters