IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Start all instances Start maintenance mode all instances »

› › › ›

Stop all instances

edit

Stop all instances

edit

This endpoint is deprecated and scheduled to be removed in the next major version. Use stop all resource instances instead.

Stops all the instances belonging to a Apm cluster.

Request

edit

POST /api/v1/clusters/apm/{cluster_id}/instances/_stop

Path parameters

edit

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

Responses

edit

202

(ClusterCommandResponse)

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

403

(BasicFailedReply)

The stop 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/_stop \
-H "Authorization: ApiKey $ECE_API_KEY"

« Start all instances Start maintenance mode all instances »