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 maintenance mode (all instances) Stop instances »

› › › ›

Start instances

edit

Start instances

edit

Starts instances belonging to a Deployment Resource.

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment.
`instance_ids`	`array[string]`	Y	A comma-separated list of instance identifiers.
`ref_id`	`string`	Y	User-specified RefId for the Resource.
`resource_kind`	`string`	Y	The kind of resource (one of elasticsearch, kibana or apm).

Query parameters

edit

Name	Type	Required	Description
`ignore_missing`	`boolean`; default: `false`	N	If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error

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

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

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/{instance_ids}/_start \
-H "Authorization: ApiKey $ECE_API_KEY"

« Stop maintenance mode (all instances) Stop instances »