POST
/
contentful
/
v1
/
sync
/
list-files
List content synchronously
curl --request POST \
  --url https://eu.phrase.com/bifrost/contentful/v1/sync/list-files \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "contentfulCredentials": {
    "contentful2SpacePreviewTokenMap": {},
    "managementApiAccessToken": "<string>",
    "middlemanAuthToken": "<string>"
  },
  "connectorUuid": "<string>",
  "configuration": {
    "tags": [
      "<string>"
    ],
    "tagFilterListingStrategy": "WITH_ALL_TAGS",
    "fieldsToOmit": [
      "<string>"
    ],
    "followAliases": true,
    "includeReferences": true,
    "includeReferencesInChangeDetection": true,
    "useApp": true,
    "middlemanTargetLocales": [
      "AA"
    ]
  },
  "path": {
    "pathType": "ENTRY",
    "spaceId": "<string>",
    "environmentId": "<string>",
    "aliasId": "<string>"
  },
  "locale": "AA"
}'
{
  "remoteResources": [
    {
      "path": {
        "contentfulPathType": "ENTRY",
        "spaceId": "xn3q5awwr3uz",
        "environmentId": "testEnv",
        "entryId": "6jDrz4Xa9hjzs5ZGhR9wqS"
      },
      "metadata": {
        "name": "test entry 1"
      }
    },
    {
      "path": {
        "contentfulPathType": "ENTRY",
        "spaceId": "xn3q5awwr3uz",
        "environmentId": "testEnv",
        "entryId": "1jF3ilMNFZ5UB5SbALWJil"
      },
      "metadata": {
        "name": "test entry 2"
      }
    }
  ]
}

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
string

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.

Body

application/json

Response

200 - application/json

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.

The response is of type any.