Skip to main content
DELETE
/
api
/
v1
/
clusters
/
hetzner
/
{cluster_id}
Deprovision a Hetzner cluster
import requests

url = "https://platform.ankra.app/api/v1/clusters/hetzner/{cluster_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.ankra.app/api/v1/clusters/hetzner/{cluster_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
curl --request DELETE \
--url https://platform.ankra.app/api/v1/clusters/hetzner/{cluster_id} \
--header 'Authorization: Bearer <token>'
{
  "cluster_id": "<string>",
  "operation_id": "<string>",
  "success": true
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

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

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

cluster_id
string<uuid>
required

Query Parameters

force
string | null

Set to 'true' to force deprovision without waiting for the cluster agent. Use only when the cluster agent is permanently offline; cloud resources may leak if Vault or the agent cannot be reached during teardown.

Response

Cluster deprovisioned successfully

cluster_id
string<uuid4>
required
operation_id
string<uuid4> | null
success
boolean
default:true