Move clusters by type

Moves clusters of a given type off an allocator.

Request

POST /api/v1/platform/infrastructure/allocators/{allocator_id}/clusters/{cluster_type}/_move

Path Parameters

allocator_id (required)
(string) The identifier of the allocator of which to move clusters.
cluster_type (required)
(string; allowed values: [elasticsearch, kibana]) The type of clusters to move off the allocator (either Elasticsearch or Kibana). If not specified, then all clusters are moved.

Query Parameters

allocator_down
(boolean; default: false) If true all clusters on the allocator will be considered to be permanently down for the purposes of data migration logic
force_update
(boolean; default: false) If true, will cancel any pending plans and overwrite with this move plan for all clusters, else will error
validate_only
(boolean; default: false) If true, will validate the plan overrides and return the plan that would be applied, without performing the move.

Request body

(MoveClustersRequest) Overrides defaults for the move of each cluster

Responses

202
(MoveClustersCommandResponse) The move command was issued successfully, use the "GET" command on each /{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.
449
(BasicFailedReply) When running as an administrator (other than root), sudo is required (code: 'root.needs_sudo')