Start maintenance mode all instancesedit
This endpoint is deprecated and scheduled to be removed in the next major version. Use start maintenance mode on all resource instances instead.
Starts maintenance mode of all instances belonging to a Apm cluster.
Requestedit
POST /api/v1/clusters/apm/{cluster_id}/instances/maintenance-mode/_start
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The APM deployment identifier. |
Responsesedit
-
202 -
The start maintenance mode command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
-
403 -
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 -
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 -
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
-
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/clusters/apm/{cluster_id}/instances/maintenance-mode/_start \
-H "Authorization: ApiKey $ECE_API_KEY"