Waiting for engine...
Skip to main content

Boomi MFT - AFT Content API Reference (v1) - Download

Toggle Pane

Download OpenAPI Specification: Download

Run In Postman

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

Download

Retrieval of file content. Files can be streamed directly by an authenticated caller, or exposed to an external recipient through a short-lived presigned token that carries its own authorization. Both paths support HTTP range requests for partial and resumable downloads.

Generate a short-lived presigned download URL for a file

Mints a time- and use-limited token that grants anonymous download of a single file, suitable for handing to an external recipient. The token is returned as { "presignedUrl": "<token>" } and is redeemed at GET /api/Files/1.0/presigned/{presignedUrl}/content. Requires the FileDownload permission.

Required privilege: File Download.

Authorizations:
ApiKeyOAuth2BearerAuth
path Parameters
fileReferenceId
required
string

Identifier of the file to expose.

header Parameters
ThruApplication
string
Default: ThruApplication

Optional. Name of the calling application, recorded for tracing. Sent as the ThruApplication header.

X-Thru-Tracking-ThruNodeId
string
Default:

Optional. Identifier of the MFT node that originated the request, recorded for tracing. Sent as the X-Thru-Tracking-ThruNodeId header.

Request Body schema: application/json

Target endpoint path plus limits: MaxDownloads (1–10) and ActiveDuration (1–86400 seconds).

endpointPath
string or null

Flow endpoint path that locates the file's storage, in /{customerCode}/{flow}/{flowEndpoint} form.

maxDownloads
integer <int32>

Maximum number of times the token may be redeemed. Between 1 and 10.

activeDuration
integer <int32>

Lifetime of the token in seconds, from the moment it is issued. Between 1 and 86400 (24 hours).

Responses

Response Schema: application/json
presignedUrl
string or null

The opaque presigned token. Redeem it at GET /api/Files/1.0/presigned/{presignedUrl}/content.

Request samples

Content type
application/json
{
  • "endpointPath": "/acme/invoices-inbound/partner-drop",
  • "maxDownloads": 3,
  • "activeDuration": 3600
}

Response samples

Content type
application/json
{
  • "presignedUrl": "9f3c1d7e-4b2a-4c8f-9a10-2d6e5b7c8a91"
}

Download a file's content by file reference

Streams the bytes of the referenced file back to an authenticated caller. Supports HTTP range requests for partial/resumable downloads. Requires the FileDownload permission.

Required privilege: File Download.

Authorizations:
ApiKeyOAuth2BearerAuth
path Parameters
fileReferenceId
required
string

Identifier of the file to download.

query Parameters
endpointPath
string

Flow endpoint path that locates the file's storage.

header Parameters
ThruApplication
string
Default: ThruApplication

Optional. Name of the calling application, recorded for tracing. Sent as the ThruApplication header.

X-Thru-Tracking-ThruNodeId
string
Default:

Optional. Identifier of the MFT node that originated the request, recorded for tracing. Sent as the X-Thru-Tracking-ThruNodeId header.

Responses

Response Headers
X-Thru-Path
string
Example: "/2026/08/invoices-2026-08-21.csv"

Path of the stored file relative to the endpoint root.

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Download a file's content using a presigned token

Redeems a presigned token issued by POST /api/Files/1.0/{fileReferenceId}/presigned and streams the file content. Anonymous: the token itself authorizes the download, so no bearer credentials are required. The token expires and is capped to a maximum number of downloads; once exhausted or expired it is rejected. Supports HTTP range requests.

Required privilege: none — this operation is unauthenticated.

Authorizations:
None
path Parameters
presignedUrl
required
string

The presigned token to redeem.

header Parameters
ThruApplication
string
Default: thru-web-ui

Optional. Name of the calling application, recorded for tracing. Sent as the ThruApplication header.

X-Thru-Tracking-ThruNodeId
string
Default:

Optional. Identifier of the MFT node that originated the request, recorded for tracing. Sent as the X-Thru-Tracking-ThruNodeId header.

Responses

Response Headers
X-Thru-Path
string
Example: "/2026/08/invoices-2026-08-21.csv"

Path of the stored file relative to the endpoint root.

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}