Skip to main content
POST
List 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.

Body

application/json

Request body for listing Knak translation requests. The response is a list of remoteResources you can feed back into the download endpoint.

credentials
object
required

Connection holding the Knak API key.

path
object
required

Which translation requests to list: ROOT (all visible to the API user, optionally filtered).

sourceLocale
string
default:""
required

Locale of the items to list (locale code, e.g. en).

Minimum string length: 1
Example:

"en"

configuration
any
default:""

Knak-specific settings (currently none); may be omitted.

{key}
any

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.

remoteResources
object[]
{key}
any