Start maintenance mode all instancesedit
DEPRECATED (Scheduled to be removed in the next major version): Starts maintenance mode on all of the instances in the Elasticsearch cluster.
Requestedit
POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/maintenance-mode/_start
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Responsesedit
-
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)Headers
-
x-cloud-error-codes(string; allowed values: [clusters.command_prohibited]) - The error codes associated with the response
-
-
404 -
(
BasicFailedReply) The cluster specified by {cluster_id} cannot be found. (code:clusters.cluster_not_found)Headers
-
x-cloud-error-codes(string; allowed values: [clusters.cluster_not_found]) - The error codes associated with the response
-
-
449 -
(
BasicFailedReply) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/maintenance-mode/_start \
-H "Authorization: ApiKey $ECE_API_KEY"