Forms

Download a form file

GET/form-files/{id}/download
forms:readget_form_file_downloadRead-only

Streams the file's bytes under its original name; /, \ and control characters in the name become -, and a non-ASCII name also gets an ASCII fallback in Content-Disposition. It is readable under the same rules as GET /form-files/{id}. A file whose stored object is missing is 404. GET /form-files/{id} reads its details. It changes nothing.

Path parameters

  • idstring (uuid)Required#

    The form file's id, a uuid. An unknown id, or a file you cannot see, returns 404.

Responses

200

The form file's bytes.

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
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/form-files/{id}/download\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"