Ingest

Bulk delete documents

Bulk delete documents by IDs or container tags

delete/v3/documents/bulk

Request body

idsstring[]

Array of document IDs to delete (max 100 at once)

containerTagsstring[]

Array of container tags - all documents in these containers will be deleted

filepathstring

Delete documents matching this filepath. Exact match for full paths, prefix match if ending with /

Example request

{
  "ids": [
    "acxV5LHMEsG2hMSNb4umbn",
    "bxcV5LHMEsG2hMSNb4umbn"
  ]
}

Response

Bulk deletion completed successfully

successboolean required

Whether the bulk deletion was successful

deletedCountnumber required

Number of documents successfully deleted

containerTagsstring[]

Container tags that were processed (only applicable when deleting by container tags)

Example response

{
  "success": true,
  "deletedCount": 2,
  "containerTags": [
    "user_123",
    "project_123"
  ]
}

Changes

Changed in 6 of the 46 revisions of this API.225

    • added the new optional request property filepath

      new-optional-request-property

    • api tag Ingest added

      api-tag-added

    • api tag Manage Documents removed

      api-tag-removed

    • request body became required

      request-body-became-required

    • changed the pattern of the request property containerTags/items/ from ^[a-zA-Z0-9_-]+$ to ^[a-zA-Z0-9_:-]+$

      request-property-pattern-changed

    • added the pattern ^[a-zA-Z0-9_-]+$ to the request property containerTags/items/

      request-property-pattern-added

    • the containerTags/items/ request property's maxLength was set to 100

      request-property-max-length-set

    • request property containerTags deprecated

      request-property-deprecated

    • response property containerTags deprecated

      response-property-deprecated