It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Start maintenance mode all instances
editStart maintenance mode all instances
editStarts maintenance mode on all of the instances in the Elasticsearch cluster.
Request
editPOST /api/v1/clusters/elasticsearch/{cluster_id}/instances/maintenance-mode/_start
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
Responses
edit-
202
-
(
ClusterCommandResponse
) Maintenance mode has started. To monitor progress, use theGET
command on the /{cluster_id} resource. -
403
-
(
BasicFailedReply
) You are unable to start maintenance mode. -
404
-
(
BasicFailedReply
) One or more {instance_id} can't be found. (code: 'clusters.instances_not_found') -
449
-
(
BasicFailedReply
) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/maintenance-mode/_start \ -u $CLOUD_USER:$CLOUD_KEY