Sign in

v1

latestOpenAPI 3.0.3GPL-3.02026-07-177978150.2 KB
documents

Delete a bunch of documents

Delete a bunch of documents that match a specific filter condition. Use the batch_size parameter to control the number of documents that should deleted at a time. A larger value will speed up deletions, but will impact performance of other operations running on the server.

delete/collections/{collectionName}/documents

Path parameters

collectionNamestring required

The name of the collection to delete documents from

Query parameters

filter_bystring required
batch_sizeinteger

Batch size parameter controls the number of documents that should be deleted at a time. A larger value will speed up deletions, but will impact performance of other operations running on the server.

ignore_not_foundboolean
truncateboolean

When true, removes all documents from the collection while preserving the collection and its schema.

{
  "filter_by": "num_employees:>100 && country: [USA, UK]"
}

Response

Documents successfully deleted

num_deletedinteger required