Start all instances

edit

Start all instances

edit

Starts all instances belonging to a Deployment Resource.

Request

edit

POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment.
`ref_id`	`string`	Y	User-specified RefId for the Resource (or '_main' if there is only one).
`resource_kind`	`string`	Y	The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).

Responses

edit

202

(DeploymentResourceCommandResponse)

The start command was issued successfully.

403

(BasicFailedReply)

The start maintenance mode command was prohibited for the given Resource. (code: deployments.instance_update_prohibited_error)

Headers

x-cloud-error-codes (string; allowed values: [deployments.instance_update_prohibited_error]): The error codes associated with the response

404

(BasicFailedReply)

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
One or more instances of the given resource type are missing. (code: deployments.instances_missing_on_update_error)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found, deployments.deployment_resource_not_found, deployments.instances_missing_on_update_error]): The error codes associated with the response

500

(BasicFailedReply)

A Resource that was previously stored no longer exists. (code: deployments.deployment_resource_no_longer_exists)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_no_longer_exists]): The error codes associated with the response

Request example

edit

curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start \
-H "Authorization: ApiKey $ECE_API_KEY"

« Get details about heap dumps for a Deployment Stop all instances »