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.
Stop instancesedit
Stops the instances belonging to a Apm cluster.
Requestedit
POST /api/v1/clusters/apm/{cluster_id}/instances/{instance_ids}/_stop
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The APM deployment identifier. |
|
|
Y |
A comma-separated list of instance identifiers. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
Responsesedit
-
202
-
(
ClusterCommandResponse
) The instances are stopping. To monitor progress, use theGET
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 exampleedit
curl -XPOST {{hostname}}/api/v1/clusters/apm/{cluster_id}/instances/{instance_ids}/_stop \ -u $CLOUD_USER:$CLOUD_KEY