Skip to main content
POST
/
contentful
/
v1
/
sync
/
download-raw-file
Download raw content synchronously
curl --request POST \
  --url https://eu.phrase.com/connectors/contentful/v1/sync/download-raw-file \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configuration": {
    "tags": [
      "<string>"
    ],
    "tagFilterListingStrategy": "WITH_ALL_TAGS",
    "fieldsToOmit": [
      "<string>"
    ],
    "followAliases": true,
    "includeReferences": true,
    "includeReferencesInChangeDetection": true,
    "useApp": true,
    "middlemanTargetLocales": [
      "AA"
    ]
  },
  "contentfulCredentials": {
    "contentful2SpacePreviewTokenMap": {},
    "managementApiAccessToken": "<string>",
    "middlemanAuthToken": "<string>"
  },
  "connectorUuid": "<string>",
  "path": {
    "pathType": "ENTRY",
    "spaceId": "<string>",
    "environmentId": "<string>",
    "aliasId": "<string>"
  },
  "locale": "AA"
}
'
{
  "storageId": "e48eda63928c4155bez9fdbsaadc15f3"
}

Authorizations

Authorization
string
header
required

Authorization token. The value is received by using the /authenticate endpoint. Example: OLi6jKa0VVyJqC5Ojv5LH2myTckP5N8Eb0rrWvdTOxCkJjT14E1AEj63bvzZ7CKM5

Headers

X-ActionId
string

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.

Available options:
ID,
OBJECT

Body

application/json
configuration
object
required

Configuration for the operation.

contentfulCredentials
object

Two Contentful API access tokens: one for the preview API and one for the management API. You can alternatively provide a connectorUuid if the connector is already created in Phrase TMS.

connectorUuid
string

UUID of the connector (corresponds to localToken). Can be used as an alternative to contentfulCredentials if the connector is already created in Phrase TMS. Connector configuration in Phrase TMS is ignored, only the credentials are used. Provide a specific configuration in the configuration field.

path
object

Path to the contentful entry where the file should be uploaded/downloaded

  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
locale
enum<string>

Locale of the contentful entry

Available options:
AA,
AB,
ACE,
ACE_ARAB,
ACE_LATN,
ACH,
ACQ,
ACQ_YE,
AF,
AF_NA,
AF_ZA,
AFB,
AFB_SA,
AK,
AK_GH,
AN,
AM,
AM_ET,
APC,
AR,
AR_001,
AR_145,
AR_AE,
AR_ARABIZI,
AR_BH,
AR_DJ,
AR_DZ,
AR_EG,
AR_EH,
AR_ER,
AR_IL,
AR_IQ,
AR_JO,
AR_KM,
AR_KW,
AR_LATN,
AR_LB,
AR_LY,
AR_MA,
AR_MOD,
AR_MR,
AR_OM,
AR_PS,
AR_QA,
AR_SA,
AR_SD,
AR_SN,
AR_SO,
AR_SS,
AR_SY,
AR_TN,
AR_YE,
ARC,
ARS,
ARS_SA,
AS,
AS_IN,
AS_LATN,
AST,
AV,
AY,
AYH,
AYH_YE,
AYN,
AYN_YE,
AZ,
AZ_AZ,
AZ_ARAB,
AZ_ARAB_IR,
AZ_CYRL,
AZ_CYRL_AZ,
AZ_LATN,
AZ_LATN_AZ,
BA,
BA_RU,
BAL,
BAN,
BCI,
BE,
BE_BY,
BEM,
BFA,
BG,
BG_BG,
BG_LATN,
BG_LATN_BG,
BH,
BHO,
BI,
BIK,
BIN,
BIN_NG,
BJN,
BJN_ARAB,
BJN_LATN,
BM,
BM_LATN_ML,
BN,
BN_BD,
BN_IN,
BN_LATN,
BO,
BR,
BS,
BS_BA,
BS_CYRL,
BS_CYRL_BA,
BS_LATN,
BS_LATN_BA,
BUA,
BYN,
BYN_ER,
BWR,
CA,
CA_AD,
CA_ES,
CA_ES_VALENCIA,
CAK,
CBK,
CDO,
CE,
CE_RU,
CEB,
CEB_PH,
CFM,
CH,
CHK,
CHR,
CJA,
CJA_KH,
CJK,
CJK_AO,
CKB,
CKL,
CLD,
CNH,
CNR,
CNR_CYRL,
CNR_LATN,
CO,
CO_FR,
COR,
CR,
CRH,
CRH_LATN,
CRH_CYRL,
CRP,
CRS,
CS,
CS_CZ,
CTD,
CTG,
CTG_BD,
CV,
CY,
CY_GB,
DA,
DA_DK,
DA_FO,
DA_GL,
DAG,
DAW,
DE,
DE_AT,
DE_BE,
DE_CH,
DE_DE,
DE_DK,
DE_IT,
DE_LI,
DE_LU,
DE_NL,
DIN,
DIN_SS,
DJE,
DOI,
DSB,
DTK,
DV,
DV_MV,
DYU,
DYU_CI,
DZ,
EE,
EE_GH,
EFI,
EKY,
EL,
EL_CY,
EL_GR,
EL_LATN,
EL_LATN_GR,
EMK,
EN,
EN_001,
EN_029,
EN_039,
EN_150,
EN_151,
EN_154,
EN_155,
EN_AE,
EN_AF,
EN_AG,
EN_AI,
EN_AL,
EN_AM,
EN_AQ,
EN_AS,
EN_AU,
EN_AR,
EN_AW,
EN_AX,
EN_AZ,
EN_BA,
EN_BB,
EN_BD,
EN_BE,
EN_BH,
EN_BL,
EN_BM,
EN_BN,
EN_BQ,
EN_BR,
EN_BS,
EN_BT,
EN_BW,
EN_BZ,
EN_CA,
EN_CC,
EN_CL,
EN_CH,
EN_CK,
EN_CN,
EN_CO,
EN_CW,
EN_CX,
EN_CY,
EN_CZ,
EN_DE,
EN_DK,
EN_DM,
EN_DZ,
EN_EG,
EN_ER,
EN_ES,
EN_ET,
EN_FI,
EN_FJ,
EN_FK,
EN_FM,
EN_FO,
EN_FR,
EN_GB,
EN_GD,
EN_GE,
EN_GF,
EN_GG,
EN_GH,
EN_GI,
EN_GL,
EN_GM,
EN_GP,
EN_GQ,
EN_GR,
EN_GS,
EN_GU,
EN_GW,
EN_GY,
EN_HK,
EN_HM,
EN_HT,
EN_HU,
EN_ID,
EN_IE,
EN_IL,
EN_IM,
EN_IN,
EN_IO,
EN_IQ,
EN_IS,
EN_IT,
EN_JA,
EN_JE,
EN_JM,
EN_JO,
EN_JP,
EN_KE,
EN_KH,
EN_KI,
EN_KM,
EN_KN,
EN_KR,
EN_KW,
EN_KY,
EN_KZ,
EN_LA,
EN_LB,
EN_LC,
EN_LK,
EN_LR,
EN_LS,
EN_LY,
EN_MA,
EN_ME,
EN_MG,
EN_MH,
EN_MK,
EN_MM,
EN_MN,
EN_MO,
EN_MP,
EN_MQ,
EN_MS,
EN_MT,
EN_MU,
EN_MV,
EN_MW,
EN_MX,
EN_MY,
EN_MZ,
EN_NA,
EN_NF,
EN_NG,
EN_NL,
EN_NO,
EN_NP,
EN_NR,
EN_NU,
EN_NZ,
EN_OM,
EN_PE,
EN_PG,
EN_PH,
EN_PK,
EN_PM,
EN_PN,
EN_PR,
EN_PT,
EN_PW,
EN_QA,
EN_RS,
EN_RU,
EN_RW,
EN_SA,
EN_SB,
EN_SC,
EN_SD,
EN_SE,
EN_SG,
EN_SH,
EN_SI,
EN_SK,
EN_SL,
EN_SO,
EN_SR,
EN_SS,
EN_SX,
EN_SY,
EN_SZ,
EN_TC,
EN_TH,
EN_TK,
EN_TL,
EN_TM,
EN_TN,
EN_TO,
EN_TR,
EN_TT,
EN_TV,
EN_TW,
EN_TZ,
EN_UG,
EN_UM,
EN_US,
EN_VC,
EN_VG,
EN_VI,
EN_VN,
EN_VU,
EN_WF,
EN_WS,
EN_YE,
EN_ZA,
EN_ZM,
EN_ZW,
EO,
ES,
ES_001,
ES_419,
ES_AD,
ES_AR,
ES_AW,
ES_BB,
ES_BO,
ES_BZ,
ES_CL,
ES_CO,
ES_CR,
ES_CU,
ES_DO,
ES_EC,
ES_ES,
ES_GQ,
ES_GT,
ES_HN,
ES_JM,
ES_MX,
ES_NI,
ES_PA,
ES_PE,
ES_PR,
ES_PY,
ES_SV,
ES_TT,
ES_US,
ES_UY,
ES_VE,
ET,
ET_EE,
EU,
EU_ES,
EWO,
EWO_CM,
FA,
FA_AF,
FA_IR,
FA_LATN,
FA_LATN_IR,
FAN,
FAT,
FF,
FF_LATN_GM,
FF_LATN_GN,
FF_LATN_GW,
FI,
FI_FI,
FIA,
FIA_ARAB,
FIA_ARAB_EG,
FIA_LATN,
FIL,
FIL_PH,
FJ,
FJ_FJ,
FO,
FO_FO,
FON,
FR,
FR_001,
FR_015,
FR_AD,
FR_BE,
FR_BF,
FR_BI,
FR_BJ,
FR_BL,
FR_CA,
FR_CD,
FR_CF,
FR_CG,
FR_CH,
FR_CI,
FR_CM,
FR_DJ,
FR_DZ,
FR_FR,
FR_GA,
FR_GF,
FR_GN,
FR_GP,
FR_GQ,
FR_HT,
FR_KM,
FR_LB,
FR_LU,
FR_MA,
FR_MC,
FR_MF,
FR_MG,
FR_ML,
FR_MQ,
FR_MR,
FR_MU,
FR_NC,
FR_NE,
FR_PF,
FR_PM,
FR_RE,
FR_RW,
FR_SC,
FR_SN,
FR_TD,
FR_TF,
FR_TG,
FR_TN,
FR_WF,
FR_YT,
FIT,
FUB,
FUC,
FUR,
FVR,
FY,
GA,
GA_IE,
GAG,
GAN,
GD,
GD_GB,
GD_IE,
GIL,
GL,
GL_ES,
GLW,
GN,
GOM,
GU,
GU_IN,
GUR,
GUR_GH,
GUW,
GUX,
GUZ,
GUZ_KE,
HA,
HA_LATN_NE,
HA_LATN_NG,
HAK,
HAW,
HAZ,
HBS,
HE,
HE_IL,
HE_RU,
HI,
HI_FJ,
HI_IN,
HI_LATN,
HIA,
HIG,
HIL,
HIL_PH,
HLT,
HMN,
HNJ,
HR,
HR_BA,
HR_HR,
HSB,
HT,
HT_HT,
HU,
HU_HU,
HUP,
HY,
HY_AM,
HY_LATN,
HY_LATN_AM,
HZ,
IA,
IBB,
ID,
ID_ID,
IG,
IG_NG,
II,
IKE,
IKT,
ILO,
ILO_PH,
IN,
IN_ID,
INH,
IS,
IS_IS,
ISO,
IT,
IT_CH,
IT_IT,
IT_SM,
IT_VA,
IU,
IU_CA,
IU_CANS,
IU_CANS_CA,
IU_LATN,
IUM,
IW,
IW_IL,
JA,
JA_JP,
JA_JP_JP,
JA_US,
JAM,
JI,
JRA,
JV,
KA,
KA_GE,
KAA,
KAB,
KAB_LATN_DZ,
KAC,
KAC_MM,
KAM,
KAM_KE,
KAR,
KBD,
KEA,
KEA_CV,
KEK,
KG,
KG_AO,
KHQ,
KHQ_ML,
KI,
KJ,
KL,
KL_GL,
KLN,
KLN_KE,
KK,
KK_LATN,
KK_KZ,
KK_CYRL_KZ,
KM,
KM_KH,
KM_VN,
KMB,
KMB_AO,
KMR,
KMR_SY,
KMR_TR,
KN,
KN_IN,
KO,
KO_KP,
KO_KR,
KO_US,
KOK,
KOK_IN,
KOS,
KPE,
KR,
KR_LATN,
KRI,
KRL,
KS,
KS_ARAB,
KS_DEVA,
KTU,
KU,
KU_ARAB,
KU_ARAB_IQ,
KUN,
KV,
KY,
KY_KG,
KYU,
KZ,
LA,
LB,
LB_LU,
LG,
LG_UG,
LI,
LIF,
LIJ,
LIR,
LMO,
LN,
LN_AO,
LN_CD,
LN_CF,
LN_CG,
LO,
LO_LA,
LOL,
LT,
LT_LT,
LT_LV,
LT_RU,
LTG,
LU,
LUA,
LUO,
LUO_KE,
LUS,
LV,
LV_LV,
LV_RU,
MAD,
MAI,
MAN,
MAM,
MDH,
MER,
MFE,
MFI,
MFI_CM,
MFI_NG,
MG,
MG_MG,
MH,
MHR,
MI,
MI_NZ,
MIN,
MIN_ARAB,
MIN_LATN,
MK,
MK_MK,
ML,
ML_IN,
MN,
MN_MN,
MNI,
MNI_MTEI,
MNK,
MOS,
MR,
MR_IN,
MRL,
MRW,
MRT,
MS,
MS_ARAB,
MS_ARAB_MY,
MS_BN,
MS_LATN_MY,
MS_LATN_SG,
MS_MY,
MS_SG,
MT,
MT_MT,
MWW,
MXT,
MY,
MY_MM,
MYX,
NAN,
NAN_TW,
NB,
NB_NO,
ND,
ND_ZW,
NDC,
NDS,
NE,
NE_NP,
NEW,
NGC,
NL,
NL_001,
NL_BE,
NL_CW,
NL_NL,
NL_SR,
NN,
NN_NO,
NNB,
NO,
NO_NO,
NO_NO_NY,
NR,
NSO,
NSO_ZA,
NUJ,
NUS,
NV,
NY,
NY_MW,
NY_ZM,
NYN,
OC,
OM,
OM_ET,
OM_KE,
OR,
OR_IN,
OR_LATN,
OR_LATN_IN,
OS,
OTQ,
PA,
PA_ARAB,
PA_ARAB_PK,
PA_GURU,
PA_GURU_IN,
PA_GURU_PK,
PA_CA,
PA_IN,
PA_PK,
PAG,
PAM,
PAP,
PAU,
PCD,
PCM,
PGA,
PGA_LATN,
PIS,
PL,
PL_PL,
PON,
PRS,
PRS_AF,
PS,
PS_AF,
PT,
PT_001,
PT_AO,
PT_BR,
PT_CV,
PT_GW,
PT_MZ,
PT_PT,
PT_ST,
PT_TL,
PT_US,
QU,
QU_BO,
QU_EC,
QU_GT,
QU_PE,
QUC,
QUY,
QUZ,
QUZ_PE,
RAJ,
RCF,
RHG,
RHG_LATN,
RHG_ROHG,
RHG_BENG,
RHL,
RM,
RM_CH,
RMC,
RMC_CYRL,
RMC_LATN,
RMY,
RMY_CYRL,
RMY_LATN,
RN,
RN_BI,
RO,
RO_MD,
RO_RO,
ROM,
RU,
RU_BY,
RU_EE,
RU_IL,
RU_KG,
RU_KZ,
RU_LATN,
RU_LATN_RU,
RU_LT,
RU_LV,
RU_MD,
RU_RU,
RU_TJ,
RU_TM,
RU_UA,
RU_UZ,
RUE,
RUP,
RW,
RW_RW,
SA,
SAT,
SB,
SC,
SC_IT,
SCN,
SD,
SD_ARAB,
SD_ARAB_PK,
SD_DEVA,
SD_DEVA_PK,
SDH,
SDH_ARAB,
SE,
SE_FI,
SE_NO,
SE_SE,
SEH,
SES,
SG,
SG_CF,
SGC,
SHN,
SHN_MM,
SHR,
SHU,
SHU_LATN,
SHU_LATN_NG,
SHU_TD,
SI,
SID,
SI_LK,
SK,
SK_SK,
SL,
SL_SL,
SL_SI,
SM,
SM_WS,
SMA,
SMA_NO,
SMA_SE,
SMJ,
SMJ_NO,
SMJ_SE,
SMN,
SMN_FI,
SMS,
SMS_FI,
SN,
SNK,
SO,
SO_DJ,
SO_ET,
SO_KE,
SO_LATN_SO,
SO_SO,
SQ,
SQ_AL,
SQ_MK,
SQ_XK,
SR,
SR_BA,
SR_CS,
SR_ME,
SR_RS,
SR_CYRL,
SR_CYRL_BA,
SR_CYRL_ME,
SR_CYRL_RS,
SR_LATN,
SR_LATN_BA,
SR_LATN_CS,
SR_LATN_ME,
SR_LATN_RS,
SS,
SS_SZ,
ST,
ST_LS,
ST_ZA,
SU,
SV,
SV_AX,
SV_FI,
SV_SE,
SV_SK,
SW,
SW_CD,
SW_KE,
SW_TZ,
SW_UG,
SYL,
SYR,
SYR_SY,
SZL,
SZL_PL,
TA,
TA_IN,
TA_LATN,
TA_LATN_IN,
TA_LK,
TA_MY,
TA_SG,
TAQ,
TAQ_ML,
TBF,
TCS,
TCY,
TE,
TE_IN,
TE_LATN,
TE_LATN_IN,
TEO,
TEO_UG,
TET,
TG,
TG_TJ,
TG_CYRL,
TG_CYRL_TJ,
TH,
TH_TH,
TH_TH_TH,
TI,
TI_ET,
TI_ER,
TIG,
TIG_ER,
TK,
TK_IQ,
TK_TM,
TL,
TL_PH,
TLH,
TLH_LATN,
TLH_PIQD,
TN,
TN_BW,
TN_ZA,
TO,
TO_NZ,
TO_TO,
TOB,
TPI,
TR,
TR_TR,
TS,
TS_ZA,
TSG,
TSG_PH,
TT,
TT_RU,
TUM,
TUM_LATN,
TUQ,
TW,
TY,
TZM,
UG,
UG_ARAB,
UG_CN,
UK,
UK_LATN,
UK_LATN_UA,
UK_PL,
UK_UA,
UMB,
UMB_AO,
UR,
UR_BD,
UR_IN,
UR_LATN,
UR_LK,
UR_PK,
UZ,
UZ_CYRL,
UZ_CYRL_UZ,
UZ_LATN,
UZ_LATN_UZ,
UZ_UZ,
VE,
VE_ZA,
VEC,
VI,
VI_US,
VI_VN,
VLS,
WA,
WAR,
WEN,
WES,
WES_CM,
WES_NG,
WO,
WO_SN,
XH,
XH_ZA,
XSM,
XSM_GH,
YAO,
YAP,
YI,
YMM,
YO,
YO_NG,
YPK,
YUA,
YUE,
ZA,
ZGH,
ZGH_DZ,
ZH,
ZH_CN,
ZH_HANS,
ZH_HANS_CN,
ZH_HANS_HK,
ZH_HANS_KR,
ZH_HANS_MY,
ZH_HANS_SG,
ZH_HANS_US,
ZH_HANT,
ZH_HANT_CN,
ZH_HANT_HK,
ZH_HANT_TW,
ZH_HK,
ZH_MY,
ZH_MO,
ZH_SG,
ZH_TW,
ZIW,
ZNE,
ZOM,
ZU,
ZU_ZA,
ZYP,
ZZA

Response

Successful operation. If X-ResponseType is set to 'ID' or no value is sent in the header, the file is saved and can be retrieved by sending a GET request to this endpoint. If X-ResponseType is set to 'OBJECT', the file is returned as a stream.