Cancel pending plan | Elastic Cloud Enterprise Reference [2.5]

A newer version is available. For the latest information, see the current release documentation.

› › › ›

Cancel pending planedit

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

Requestedit

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

Path parametersedit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Elasticsearch cluster 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)

Headers

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

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)

Headers

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

449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]): 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 exampleedit

curl -XDELETE https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/plan/pending \
-H "Authorization: ApiKey $ECE_API_KEY"

« Get plan activity Get pending plan »