Get environments for service

Base URL: https://{kibana_url}

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

Auth

Retrieve the available environments for a given service, to be used in agent configuration. You must have read privileges for the APM and User Experience feature in Kibana. If serviceName is omitted, environments across all services are returned.

Query parameters

serviceName string: The name of the service. If omitted, environments across all services are returned.; Example: opbeans-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

environments object[]: Service environment list

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

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

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/apm/settings/agent-configuration/environments" \
  -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/environments.

{
  "environments": [
    {
      "alreadyConfigured": true,
      "name": "production"
    },
    {
      "alreadyConfigured": false,
      "name": "development"
    },
    {
      "alreadyConfigured": false,
      "name": "ALL_OPTION_VALUE"
    }
  ]
}

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