compute
DELETE /v1/compute/clusters/{clusterId}
Delete a cluster and every machine in it.
Authentication
Send an API key as a bearer token. The key must carry the sites.delete permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X DELETE https://api.zinndigital.com/v1/compute/clusters/{clusterId} \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
202. ⛔ Irreversible: every node is deleted with its disk, its floating IPs are released, its meter is settled, and the network and the cluster's keys are removed. Refused while the cluster is still being built. Requires sites.delete.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
clusterId (path) | Uuid | Yes | The cluster's id, as listComputeClusters reports it. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Yes | — |
deploy_target | string | Yes | — |
zone | string | Yes | — |
plan_code | string | Yes | — |
image | string | Yes | — |
worker_count | integer | Yes | — |
install_argocd | boolean | Yes | — |
deploy_sample_app | boolean | Yes | — |
status | string<pending, provisioning, bootstrapping, ready, failed, terminating, terminated> | Yes | — |
message | string | Yes | — |
kubernetes_version | string | Yes | — |
argocd_version | string | Yes | — |
ready_nodes | integer | Yes | — |
sample_app_health | string | Yes | Argo CD's sync/health for the sample application, e.g. Synced/Healthy. |
api_address | string | Yes | The Kubernetes API's public address (port 6443). |
network_id | string | Yes | — |
nodes | ComputeServer[] | Yes | — |
created_at | string | Yes | — |
ready_at | object | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503