Clusters

Delete Cluster

Changed on

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}

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/clusters/{cluster_id}
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

cluster_idstring required

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.

Response

Successful Response

unknown required

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API