Cancel resource pending plan
editCancel resource pending plan
editCancels the pending plan of a Resource belonging to a given Deployment.
Request
editDELETE /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment |
|
|
Y |
User-specified RefId for the Resource (or '_main' if there is only one) |
|
|
Y |
The kind of resource |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
When |
Responses
edit-
200
-
(
DeploymentResourceCrudResponse
)Standard Deployment Resource Crud Response
-
400
-
The Resource does not have a pending plan. (code:
deployments.resource_does_not_have_a_pending_plan
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.resource_does_not_have_a_pending_plan
]) - The error codes associated with the response
-
-
404
-
The Deployment specified by {deployment_id} cannot be found. (code:
deployments.deployment_not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_not_found
]) - The error codes associated with the response
-
-
449
-
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
-
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
-
Request example
editcurl -XDELETE https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending \ -H "Authorization: ApiKey $ECE_API_KEY"