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) Identifier for the Elasticsearch cluster

Query Parameters

force_update
(boolean; default: false) If true, will cancel any pending plans and overwrite with this move plan, else will error
ignore_missing
(boolean; default: false) If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error
instances_down
(boolean; default: false) If true the the instances specified by 'instance_ids' will be considered to be permanently down for the purposes of data migration logic
validate_only
(boolean; default: false) If true, will validate the move request and return the calculated plan without actually applying it.

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) When running as an administrator (other than root), sudo is required (code: 'root.needs_sudo')