Get agent name for service

Base URL: https://{kibana_url}

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

Auth

Retrieve agentName for a service.

Query parameters

serviceName string required: The name of the service; Example: node

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

agentName string: Agent name

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/agent_name?serviceName=node

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/apm/settings/agent-configuration/agent_name?serviceName=node" \
  -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/agent_name, which returns the detected APM agent name for a service.

{
  "agentName": "nodejs"
}

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