Document Mass Uploads

Revert a mass upload

POST/document-mass-uploads/{id}/actions/revert
documents:writerevert_document_mass_uploadDestructive

Destructive, irreversible. Hard-deletes the upload's documents, files, access log and audit trail, via a job (202). status goes reverting, then reverted or revert_failed (retryable). From completed, completed_with_failures, failed, cancelled or revert_failed; else 409 invalid_state, also while files may still finish. Same-organisation peers with view-all-documents read the job at /jobs/{id}, where cancelling is 409; a legacy-started revert is hidden from them. dry_run queues nothing. Emits document_mass_upload.revert_started.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Responses

202

The job that deletes the documents was started. Its result is the last progress log, holding deleted, missing and failed counts.

Job
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "type": "string",
    "status": "queued",
    "progress": {
      "done": 1,
      "total": 1
    },
    "result": {},
    "error": {},
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00",
    "completed_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/document-mass-uploads/{id}/actions/revert\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"