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.

Elastic Docs ›Elastic Cloud Enterprise Reference [2.10] ›RESTful API ›API reference ›Clusters - Kibana - CRUD - Configuration
« Get plan activity Get pending plan »

Cancel pending planedit

DEPRECATED (Scheduled to be removed in the next major version): Cancels the pending plan of the Kibana instance.

Requestedit

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

Path parametersedit

Name Type Required Description

cluster_id

string

Y

The Kibana deployment identifier.

Query parametersedit

Name Type Required Description

force_delete

boolean; default: false

N

When true, deletes the pending plan instead of attempting a graceful cancellation. The default is false.

ignore_missing

boolean; default: false

N

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

Responsesedit

200

(EmptyResponse) The pending plan has been successfully cancelled

404

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

412

(BasicFailedReply) There is not currently applied plan - eg the cluster has not finished provisioning, or the provisioning failed (code: 'clusters.cluster_plan_state_error')

449

(BasicFailedReply) elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')

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

Request exampleedit

curl -XDELETE https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/plan/pending \
-H "Authorization: ApiKey $ECE_API_KEY"
« Get plan activity Get pending plan »