v53

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-076771,7565.2 MB
APM agent configuration

Get environments for service

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/apm/settings/agent-configuration/environments</span></div>

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.

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

Query parameters

serviceNamestring

The name of the service. If omitted, environments across all services are returned.

Headers

elastic-api-version'2023-10-31' required

The version of the API to use

Response

Successful response

Example response

{
  "environments": [
    {
      "name": "ALL_OPTION_VALUE"
    }
  ]
}