Start maintenance mode all instances

Starts maintenance mode of all instances belonging to an Elasticsearch cluster.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/maintenance-mode/_start

Path parameters

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

Query parameters

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.

Responses

202
(ClusterCommandResponse) The start maintenance mode command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
403
(BasicFailedReply) The start maintenance mode 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"')