It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Cancel resource pending planedit
Cancels the pending plan of a Resource belonging to a given Deployment.
Requestedit
DELETE /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment |
|
|
Y |
User-specified RefId for the Resource |
|
|
Y |
The kind of resource |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
When |
Responsesedit
-
200
-
(
DeploymentResourceCrudResponse
) Standard Deployment Resource Crud Response -
400
-
(
BasicFailedReply
) 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
-
(
BasicFailedReply
) 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
-
(
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 -XDELETE {{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending \ -H "Authorization: ApiKey $ECE_API_KEY"