Sign in
kb

Delete Collection Api

Delete a collection and all its data.

This function ensures data consistency by attempting physical file deletion before database deletion. If physical deletion fails, the operation is aborted to prevent inconsistent state.

Args: collection_name: Name of the collection to delete

Returns: Deletion result with status, affected documents, and cleanup information

Raises: HTTPException: If physical deletion fails (prevents database deletion)

delete/api/kb/collections/{collection_name}

Path parameters

collection_namestring required

Response

Successful Response

statusstring required

Operation status: success|partial_success|error

collectionstring required

Collection identifier affected by the operation

messagestring required

Human-readable summary of the collection operation

warningsstring[]

Non-fatal issues encountered while processing the collection

deleted_countsobject

Aggregated deletion counts per table when applicable

Changes

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

  • c9eb29ec9a1b1See the full diff
    • ●

      added the new cancelled enum value to the affected_documents/items/status response property for the response status 200

      response-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog