Skip to main content
DELETE
Deprovision an AWS EC2 cluster

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-ankra-organisation-id
string

PAT organisation override.

Path Parameters

cluster_id
string<uuid>
required

Query Parameters

force
boolean
accept_volume_data_loss
boolean

Set to 'true' to accept that the cluster's persistent volumes - the cloud volumes its CSI driver provisioned - and the data on them are deleted with the cluster, unless its retention_policy retains them. GET .../deprovision-volumes lists them. Required, forced or not, when the delete removes volumes or cannot tell whether it does: without it the delete answers 409 naming them.

Response

Successful response

cluster_id
string<uuid>
required
operation_id
string<uuid> | null
required
success
boolean
required