Restart Deployment Stateless Resource
Restarts a Stateless Resource. If a Resource is active: this command re-applies the existing plan but applies a "cluster_reboot", which issues a restart command and waits for it to complete. If a Resource is inactive: this command starts it up with the most recent successful plan.
Path parameters
-
Identifier for the Deployment.
-
The kind of stateless resource
Values are
kibana
,apm
,appsearch
,enterprise_search
, orintegrations_server
. -
User-specified RefId for the Resource (or '_main' if there is only one).
Query parameters
-
cancel_pending boolean
If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error.
Default value is
false
.
Responses
-
The restart command was issued successfully
-
- 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
)
- The Deployment specified by {deployment_id} cannot be found. (code:
-
The command sent to a Resource found the Resource in an illegal state, the error message gives more details. (code:
deployments.deployment_resource_plan_change_error
) -
We have failed you. (code:
deployments.deployment_resource_no_longer_exists
)
curl \
-X POST https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart
{
"warnings": [
{
"code": "string",
"message": "string"
}
]
}
# Headers
x-cloud-error-codes: deployments.deployment_not_found
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
# Headers
x-cloud-error-codes: deployments.deployment_resource_plan_change_error
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
# Headers
x-cloud-error-codes: deployments.deployment_resource_no_longer_exists
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}