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 instances Start maintenance mode »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.1] ›RESTful API ›API reference ›Clusters - Apm - Commands

Stop instances

edit

Stop instances

edit

Stops the instances belonging to a Apm cluster.

Request

edit

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

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The APM deployment identifier.

instance_ids

array[string]

Y

A comma-separated list of instance identifiers.

Query parameters

edit
Name Type Required Description

ignore_missing

boolean; default: false

N

When true and the instance does not exist, proceeds to the next instance, or treats the instance as an error.

Responses

edit
202

(ClusterCommandResponse) The instances are stopping. To monitor progress, use the GET command on the /{cluster_id} resource.

403

(BasicFailedReply) You are unable to stop the instances.

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

edit
curl -XPOST {{hostname}}/api/v1/clusters/apm/{cluster_id}/instances/{instance_ids}/_stop \
-u $CLOUD_USER:$CLOUD_KEY
« Start instances Start maintenance mode »