Delete or expire all documents
DELETE/pipelines/:pipeline_id/documents
Deletes or expires every document in a pipeline. Without expire, the operation permanently removes every version and every fragment and returns status 204. With expire=true, the operation marks every current version as expired and returns status 200.
Permissions. Write and execute on the pipeline, and an allow-list that includes every classification of the pipeline.
Documents, versions and fragments compares expiry and deletion.
Request
Responses
- 200
- 204
- 400
- 401
- 403
- 404
The documents were expired (expire=true). The body is empty.
The documents were deleted. The body is empty.
The as_of value lies outside the range of valid timestamps (Invalid version).
The authentication headers are missing or invalid, or the API key is inactive or expired. Errors lists the messages.
The pipeline exists, and the key lacks write or execute permission on the pipeline or the key's classification allow-list does not include every classification of the pipeline (Unauthorized: access level ... required for Pipeline with id ...). An expiry also returns 403 when the license does not permit the operation (Invalid license: ...).
No pipeline with this identifier exists (Pipeline with id <id> not found).