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) The Elasticsearch cluster identifier.

Query parameters

validate_only
(boolean; default: false) When true, validates the cluster definition without performing 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
202
(ClusterCrudResponse) The plan definition was valid and the updated plan is in 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')
412
(BasicFailedReply) Potential risky settings have been specified (code: 'clusters.cluster_plan_state_error')
449
(BasicFailedReply) elevated permissions are required. (code: '"root.needs_elevated_permissions"')