Update plan

Updates the configuration of an existing Elasticsearch cluster.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/plan

Path Parameters

cluster_id (required)
(string) Identifier for the Elasticsearch cluster

Query Parameters

validate_only
(boolean; default: false) If true, will just validate the cluster definition but will not perform the update

Request body

(ElasticsearchClusterPlan) (required) The update plan definition

Responses

200
(ClusterCrudResponse) The cluster definition was valid - no further action was requested. The return object contains an internal representation of the plan, for use in debugging
201
(ClusterCrudResponse) The shutdown command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
400
(BasicFailedReply) The cluster definition contained errors (code: 'clusters.cluster_invalid_plan' and 'clusters.plan_feature_not_implemented')
404
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')
449
(BasicFailedReply) When running as an administrator (other than root), sudo is required (code: 'root.needs_sudo')