Get environments for service

Server: https://{kibana_url}

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

Refer to Spaces for more information.

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.

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/environments.

Request Console 1 / 2 languages

Console Kibana Dev Tools

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

curl Shell

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

Response

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