Download the mass-upload mapping template

GET/documents/mass-upload/template

documents:read download_mass_upload_templateRead-onlyDeprecatedSunset 2027-06-30

Returns the CSV mapping template for the mass-upload ZIP: one row per file, mapping a filename to its target directory_id. Deprecated: use GET /document-mass-uploads/template. It is withdrawn on 2027-06-30 and keeps running without the view-all-documents check the successor makes, so any token with the scope can still read it. Responses carry Deprecation, Sunset and a successor Link.

Responses

200

The CSV mapping template.

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

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/documents/mass-upload/template\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"