Document Mass Uploads

Cancel a mass upload

POST/document-mass-uploads/{id}/actions/cancel
documents:writecancel_document_mass_uploadIdempotent

From uploading, queued or processing to cancelled. While uploading it aborts the multipart upload; later it stops the job at its next check and fails waiting files, keeping those already added. Returns 200, also for a repeat on a cancelled upload; any other status is 409 invalid_state; 502 upstream_error if storage refuses. Gate: view-all-documents or super admin only. Else 403 missing_permission. dry_run changes nothing. Emits document_mass_upload.cancelled. It cannot be resumed.

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

200

The cancelled upload.

DocumentMassUpload
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "status": "uploading",
    "filename": "string",
    "size_bytes": 1,
    "owner_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "job_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "summary": {
      "total": 1,
      "processed": 1,
      "succeeded": 1,
      "failed": 1
    },
    "failure_reason": "string",
    "cancelled_at": "2026-06-12T10:00:00+00:00",
    "revert": {
      "job_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "status": "pending",
      "requested_at": "2026-06-12T10:00:00+00:00",
      "deleted": 1,
      "missing": 1,
      "failed": 1
    },
    "upload": {
      "part_size": 1,
      "part_count": 1,
      "expires_at": "2026-06-12T10:00:00+00:00"
    },
    "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
502

An upstream dependency (e.g. Sumsub) was unavailable (error.code = upstream_error).

Error

Examples

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