Cancel pending plan

edit

Cancels the pending plan of an APM cluster.

Request

edit

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

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The APM deployment identifier.

Query parameters

edit
Name Type Required Description

ignore_missing

boolean; default: false

N

When true, returns successfully, even when plans are pending. The default is false.

Responses

edit
200

(ApmCrudResponse) The pending plan is cancelled.

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')

449

(BasicFailedReply) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')

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

Request example

edit
curl -XDELETE {{hostname}}/api/v1/clusters/apm/{cluster_id}/plan/pending \
-u $CLOUD_USER:$CLOUD_KEY