Sign in

v1

latestOpenAPI 3.1.0License and Price2026-07-1722542.4 KB

Read a file's raw contents. Use this for direct data download.

id option:

  • Specifies the item's system ID to read.

type option:

  • Specifies content disposition or not.
  • 0: No content disposition. Returns raw binary file.
  • 1: Content disposition. May fix line endings to CR LF for text files.

bucket option:

  • Bucket is required.

name option:

  • Specify the name to save the file as (e.g document.pdf).
get/file/read

Query parameters

idstring required

Search id (e.g. "61202067-543e-4e6a-8c23-11f9b8f008cf")

type0 | 1 | 2 | 3 | 4 required

Types:
0 = Raw binary 1 = Raw binary with content disposition and optional file &name=[name] as parameter 2 = Text view, any non-printable characters shall be removed, UTF-8 encoding. Optional max &size=[number] as parameter. 3 = Hex view of data. Optional max &size=[number] as parameter. 4 = Auto-detect hex view or text view. Optional max &size=[number] as parameter. The default max size if none is specified is 1 MB.

namestring

Types:
1 = Raw binary with content disposition and optional file &name=[name] as parameter

sizeinteger

Optional max &size=[number] as parameter. The default max size if none is specified is 1 MB.

storageidstring required

Either the storage identifier or system identifier has to be specified.

systemidstring required

Either the storage identifier or system identifier has to be specified.

Response

OK