Shutdown Deployment Stateless Resourceedit
Shutdown Stateless Resource belonging to a given Deployment.
Requestedit
POST /api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown
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 |
Hide cluster on shutdown. Hidden clusters are not listed by default |
|
|
N |
If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible) |
Responsesedit
-
200
-
(
DeploymentResourceCommandResponse
) Standard response -
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
-
-
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}/_shutdown \ -H "Authorization: ApiKey $ECE_API_KEY"