It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Update plan Cancel pending plan »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.4] ›RESTful API ›API reference ›Clusters - Apm - CRUD - Configuration

Get plan activity

edit

Get plan activity

edit

Retrieves the current and historical plan information for a APM cluster.

Request

edit

GET /api/v1/clusters/apm/{cluster_id}/plan/activity

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The APM deployment identifier.

Query parameters

edit
Name Type Required Description

show_plan_defaults

boolean; default: false

N

When plans are shown, includes the default values in the response. NOTE: This option results in large responses.

show_plan_logs

boolean; default: true

N

Includes the active, pending, and historical plan information in the attempt log. NOTE: This option can result in large responses.

Responses

edit
200

(ApmPlansInfo) Returning the plan activity for the specified APM cluster

404

(BasicFailedReply) The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
The error codes associated with the response

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XGET {{hostname}}/api/v1/clusters/apm/{cluster_id}/plan/activity \
-H "Authorization: ApiKey $ECE_API_KEY"
« Update plan Cancel pending plan »