Move instances (advanced)

Moves one or more instances belonging to an Elasticsearch cluster, with custom configuration posted in the body

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/_move

Path parameters

cluster_id (required)
(string) The Elasticsearch cluster identifier.

Query parameters

force_update
(boolean; default: false) When true, cancels and overwrites the pending plans, or treats the instance as an error.
ignore_missing
(boolean; default: false) When true and the instance does not exist, proceeds to the next instance, or treats the instance as an error.
instances_down
(boolean; default: false) When true, the instances specified by instance_ids permanently shut down for data migration logic.
move_only
(boolean; default: false) When true, moves the specified instances and ignores the changes for the cluster state.
validate_only
(boolean; default: false) When true, validates the move request, then returns the calculated plan without applying the plan.

Request body

(TransientElasticsearchPlanConfiguration) (required) Overrides defaults for the move, including setting the configuration of instances specified in the path

Responses

202
(ClusterCommandResponse) The move 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')
403
(BasicFailedReply) The move command was prohibited for the given cluster.
404
(BasicFailedReply) One or more of the instances specified at {instance_ids} could not be found (code: 'clusters.instances_not_found')
449
(BasicFailedReply) elevated permissions are required. (code: '"root.needs_elevated_permissions"')