Cancel pending plan

edit

Cancels the pending plan of a Kibana cluster.

Request

edit

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

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The Kibana 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

(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.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/kibana/{cluster_id}/plan/pending \
-u $CLOUD_USER:$CLOUD_KEY