Order a cluster teardown (admin)

delete/cluster-orders/{environment}/{name}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/cluster-orders/{environment}/{name}
  • Auth: HTTP bearer

Path parameters

environmentstring required
namestring required

Query parameters

teamstring required

Response

Deprovision enqueued

idstring required
org_idstring required
namestring required
environmentstring required
teamstring required
operation'provision' | 'deprovision' | 'unwedge' required
status'pending' | 'committed' | 'failed' | 'active' | 'deprovisioned' required
git_commit_shastring required
errorstring required
spec_jsonobject required

The clusterspec input the CR was templated from.

cluster_idstring nullable required
created_bystring required
created_atstring date-time required
completed_atstring date-time nullable required
vend_phasesobject required

Regressible map keyed by phase (committed, tofu_running, active, ...). Only portal-side phases advance locally; substrate phases need the in-cluster watcher.

Changes

No recorded changes to this operation across all 14 revisions of this API.