Cancel resource pending plan
Cancels the pending plan of a Resource belonging to a given Deployment.
Path parameters
-
Identifier for the Deployment
-
The kind of resource
Values are
elasticsearch
,kibana
,apm
,appsearch
,enterprise_search
, orintegrations_server
. -
User-specified RefId for the Resource (or '_main' if there is only one)
Query parameters
-
force_delete boolean
When
true
, deletes the pending plan instead of attempting a graceful cancellation. The default isfalse
.Default value is
false
. -
ignore_missing boolean
When
true
, returns successfully, even when plans are missing. The default isfalse
.Default value is
false
.
Responses
-
Standard Deployment Resource Crud Response
-
The Resource does not have a pending plan. (code:
deployments.resource_does_not_have_a_pending_plan
) -
The Deployment specified by {deployment_id} cannot be found. (code:
deployments.deployment_not_found
) -
We have failed you. (code:
deployments.deployment_resource_no_longer_exists
)
curl \
-X DELETE https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending
{
"id": "string",
"kind": "string",
"ref_id": "string"
}
# Headers
x-cloud-error-codes: deployments.resource_does_not_have_a_pending_plan
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"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_no_longer_exists
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}