Start instances
Starts instances belonging to a Deployment Resource.
Path parameters
-
Identifier for the Deployment.
-
The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).
-
User-specified RefId for the Resource (or '_main' if there is only one).
-
A comma-separated list of instance identifiers.
Query parameters
-
ignore_missing boolean
If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error
Default value is
false
.
Responses
-
The start command was issued successfully.
-
The start maintenance mode command was prohibited for the given Resource. (code:
deployments.instance_update_prohibited_error
) -
- 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
)
- The Deployment specified by {deployment_id} cannot be found. (code:
-
A Resource that was previously stored no longer exists. (code:
deployments.deployment_resource_no_longer_exists
)
POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start
curl \
-X POST https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start
Response examples (202)
{
"warnings": [
{
"code": "string",
"message": "string"
}
]
}
Response examples (403)
# Headers
x-cloud-error-codes: deployments.instance_update_prohibited_error
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
Response examples (404)
# Headers
x-cloud-error-codes: deployments.deployment_not_found
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
Response examples (500)
# Headers
x-cloud-error-codes: deployments.deployment_resource_no_longer_exists
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}