Start maintenance mode | Elastic Cloud Enterprise Reference [2.3]

A newer version is available. For the latest information, see the current release documentation.

› › › ›

Starts maintenance mode on the specified instances in the Elasticsearch cluster.

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

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Elasticsearch cluster identifier.
`instance_ids`	`array[string]`	Y	A comma-separated list of instance identifiers.

Name	Type	Required	Description
`ignore_missing`	`boolean`; default: `false`	N	When `true` and the instance does not exist, proceeds to the next instance, or treats the instance as an error.

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. (code: clusters.command_prohibited)
404: (BasicFailedReply) * The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found) * 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.unauthorized.rbac.elevated_permissions_required)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/maintenance-mode/_start \
-u $CLOUD_USER:$CLOUD_KEY