Directories

Delete stale directories within a scope

Delete entities within the given scope that the ingestion connector did not report in the current run. The connector sends the set of FQNs it saw; entities in scope not in that set are considered stale. By default the deletion is soft; pass hardDelete=true to hard-delete instead. Returns a BulkOperationResult of deleted (or, for dryRun, would-be-deleted) entities.

delete/v1/drives/directories/deleteStale

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/drives/directories/deleteStale
  • Auth: HTTP bearer

Request body

scopeFqnstring required
scopeEntityTypestring required
seenFqnsstring[] required
dryRunboolean
hardDeleteboolean
recursiveboolean

Response

Stale deletion results

dryRunboolean
status'success' | 'failure' | 'aborted' | 'partialSuccess' | 'running'
abortReasonstring
numberOfRowsProcessedinteger
numberOfRowsPassedinteger
numberOfRowsFailedinteger

Changes

No recorded changes to this operation across all 1 revision of this API.