Skip to main content
POST
Download raw content synchronously

Authorizations

Authorization
string
header
required

IDM-issued JWT. Obtain via the IDM authentication flow and pass as: Bearer

Headers

X-ActionId
string
default:""

A logging ID of the request. It is propagated through Phrase systems, making it easier to connect logs from various services. If no ActionId is sent with a request, one will be generated by Bifrost and returned with the response.

X-ResponseType
enum<string>
default:ID

Specify if the response should contain the processed object itself in an application/octet-stream body, or a application/json body with an ID that can be then used to retrieve the object using a /load-content endpoint. Note that for larger files (> 1 MB), it is advised to use the ID option which is also default. (ID => JSON with storageId, OBJECT => binary stream).

Available options:
ID,
OBJECT

Body

application/json

Request body for downloading raw Contentful content. The connector loads its credentials from TMS using the supplied connectorUuid.

connectorUuid
string
default:""
required

UUID of a connector instance configured in TMS.

Example:

"4282fec0-d2e9-4266-8733-3e634feb7b59"

path
object
required

Selector inside the Contentful space — the entry or asset to download.

sourceLocale
string
default:""
required

Source locale of the entries being downloaded (Contentful locale code).

Example:

"en-US"

configuration
object

Contentful-specific behavior knobs (tag filter, reference inlining, asset handling, …).

{key}
any

Response

OK — raw binary stream (returned when X-ResponseType=OBJECT).

The response is of type file.