Restart Deployment Stateless Resourceedit
Restarts an 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.
Requestedit
POST /api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Deployment |
|
|
Y |
User-specified RefId for the Resource |
|
|
Y |
The kind of stateless resource |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
If true, will cancel any pending plans before restarting (else will error) |
Responsesedit
-
202 -
(
DeploymentResourceCommandResponse) The restart command was issued successfully -
404 -
(
BasicFailedReply) The Resource specified by {ref_id} cannot be found. (code:deployments.deployment_resource_not_found)Headers
-
x-cloud-error-codes(string; allowed values: [deployments.deployment_resource_not_found]) - The error codes associated with the response
-
-
422 -
(
BasicFailedReply) 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)Headers
-
x-cloud-error-codes(string; allowed values: [deployments.deployment_resource_plan_change_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) We have failed you. (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
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPOST {{hostname}}/api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart \
-H "Authorization: ApiKey $ECE_API_KEY"