Cancel resource pending plan
Auth
Cancels the pending plan of a Resource belonging to a given Deployment.
-
deployment_id
string
required
-
Identifier for the Deployment
-
resource_kind
enum
required
-
The kind of resource
-
Values:
elasticsearch
kibana
apm
appsearch
enterprise_search
integrations_server
-
ref_id
string
required
-
User-specified RefId for the Resource (or '_main' if there is only one)
-
force_delete
boolean · default: false
-
When true, deletes the pending plan instead of attempting a graceful cancellation. The default is false.
-
ignore_missing
boolean · default: false
-
When true, returns successfully, even when plans are missing. The default is false.
Standard Deployment Resource Crud Response
-
id
string
required
-
The id of the deployment
-
kind
string
required
-
The kind of the stateless resource
-
ref_id
string
required
-
The reference id of the resource
The Resource does not have a pending plan. (code: deployments.resource_does_not_have_a_pending_plan)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
required
-
A human readable message describing the error that occurred
-
fields
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields
The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
required
-
A human readable message describing the error that occurred
-
fields
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields
Vacate plans can only be cancelled by platform administrators. (code: deployments.vacate_plan_cancellation_restricted)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
required
-
A human readable message describing the error that occurred
-
fields
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields
We have failed you. (code: deployments.deployment_resource_no_longer_exists)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
required
-
A human readable message describing the error that occurred
-
fields
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields