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 Move instances »

› › › ›

Stop maintenance mode all instances

edit

Stop maintenance mode all instances

edit

DEPRECATED (Scheduled to be removed in the next major version): Stops maintenance mode of all instances belonging to a Apm cluster.

Request

edit

POST /api/v1/clusters/apm/{cluster_id}/instances/maintenance-mode/_stop

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The APM deployment identifier.

Responses

edit

202

(ClusterCommandResponse) The stop maintenance mode command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress

403

(BasicFailedReply) The stop 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

Request example

edit

curl -XPOST https://{{hostname}}/api/v1/clusters/apm/{cluster_id}/instances/maintenance-mode/_stop \
-H "Authorization: ApiKey $ECE_API_KEY"

« Start maintenance mode all instances Move instances »