IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Elastic Cloud Enterprise Reference [2.13] ›RESTful API ›API reference ›Clusters - Apm - CRUD - Configuration
« Cancel pending plan Clusters - Apm - Commands »

Get pending planedit

This endpoint is deprecated and scheduled to be removed in the next major version. Use get deployment instead.

Retrieves the pending plan of an APM cluster.

Requestedit

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

Path parametersedit

Name Type Required Description

cluster_id

string

Y

The APM deployment identifier.

Query parametersedit

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.

Responsesedit

200

(ApmPlan)

The pending plan is applied to the APM server.

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
404

(BasicFailedReply)

The {cluster_id} can't be found. (code: 'clusters.cluster_not_found')

412

(BasicFailedReply)

The APM server is unable to finish provisioning, or the provisioning failed. Apply a plan, then try again. (code: 'clusters.cluster_plan_state_error')

Request exampleedit

curl -XGET https://{{hostname}}/api/v1/clusters/apm/{cluster_id}/plan/pending \
-H "Authorization: ApiKey $ECE_API_KEY"
« Cancel pending plan Clusters - Apm - Commands »