Document Mass Uploads

Get a mass upload

GET/document-mass-uploads/{id}
documents:readget_document_mass_uploadRead-only

Returns one upload: status, zip name and size, job, file counts, why the zip failed, and the latest revert. upload shows only while uploading. The storage key and upload id are never returned as fields; each signed part URL carries both. 404 for an unknown id or another organisation's upload. Gate: view-all-documents or super admin only; no folder rights or locks are checked. Else 403 missing_permission (forbidden for a token with no user). It changes nothing.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Query parameters

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

Responses

200

The 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
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 https://your-org-domain/kong/core/api/v2/document-mass-uploads/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"