Start instancesedit

Starts the instances belonging to a Apm cluster.

Requestedit

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

Path parametersedit

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 parametersedit

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.

Responsesedit

202

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

403

(BasicFailedReply) You are unable to start the APM server.

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}/_start \
-u $CLOUD_USER:$CLOUD_KEY