Start instances
- Base URL
-
https://api.elastic-cloud.com/api/v1
No auth
Starts instances belonging to a Deployment Resource.
-
deployment_id
string
required
-
Identifier for the Deployment.
-
resource_kind
string
required
-
The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).
-
ref_id
string
required
-
User-specified RefId for the Resource (or '_main' if there is only one).
-
instance_ids
string[]
required
-
A comma-separated list of instance identifiers.
-
ignore_missing
boolean · default: false
-
If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error
The start command was issued successfully.
-
warnings
object[]
-
List of warnings generated from validating command
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
-
A human readable message describing the warning that occurred
The start maintenance mode command was prohibited for the given Resource. (code: deployments.instance_update_prohibited_error)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
required
-
A human readable message describing the error that occurred
-
fields
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields
- 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)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
required
-
A human readable message describing the error that occurred
-
fields
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields
A Resource that was previously stored no longer exists. (code: deployments.deployment_resource_no_longer_exists)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
required
-
A human readable message describing the error that occurred
-
fields
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields
Thank you for your feedback.