Sign in
Clusters

Delete Cluster

This endpoint deletes a cluster and all its resources including: - Running Ray jobs (cancels active jobs) - Cluster triggers - Execution history (clustering_results) - S3 artifacts (parquet files, documents, members) - Related tasks - Clustering jobs - MongoDB cluster metadata - Output collections created by the cluster (by default)

By default, output collections created by the cluster are cascade-deleted
along with the cluster. Pass `cascade_output_collections=false` to preserve
them (useful when the cluster output documents were enriched / promoted
into user-managed data).

The deletion is performed synchronously and returns when complete.
delete/v1/clusters/{cluster_id}

Path parameters

cluster_idstring required

Cluster ID

Cluster ID

Query parameters

cascade_output_collectionsboolean

When true (default), the cluster's output collections are deleted alongside the cluster. Set to false to preserve them.

When true (default), the cluster's output collections are deleted alongside the cluster. Set to false to preserve them.

Response

Successful Response

{"stackTrail":"paths:/v1/clusters/{cluster_id}:delete:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 1 of the 29 revisions of this API.1