Skip to main content

Get one Content Delivery Config

GET 
/v2/projects/:projectId/content-delivery-configs/:id

Get one Content Delivery Config

Request​

Path Parameters

    id int64required
    projectId int64required

Responses​

OK

Schema
    autoPublish booleanrequired
    fileStructureTemplate string

    This is a template that defines the structure of the resulting .zip file content.

    The template is a string that can contain the following placeholders: {namespace}, {languageTag}, {androidLanguageTag}, {snakeLanguageTag}, {extension}.

    For example, when exporting to JSON with the template {namespace}/{languageTag}.{extension}, the English translations of the home namespace will be stored in home/en.json.

    The {snakeLanguageTag} placeholder is the same as {languageTag} but in snake case. (e.g., en_US).

    The Android specific {androidLanguageTag} placeholder is the same as {languageTag} but in Android format. (e.g., en-rUS)

    filterKeyId int64[]

    Filter key IDs to be contained in export

    filterKeyIdNot int64[]

    Filter key IDs not to be contained in export

    filterKeyPrefix string

    Filter keys with prefix

    filterNamespace string[]

    Filter translations with namespace. By default, all namespaces everything are exported. To export default namespace, use empty string.

    filterState string[]

    Possible values: [UNTRANSLATED, TRANSLATED, REVIEWED, DISABLED]

    Filter translations with state. By default, all states except untranslated is exported.

    filterTag string

    Filter keys tagged by.

    This filter works the same as filterTagIn but in this cases it accepts single tag only.

    filterTagIn string[]

    Filter keys tagged by one of provided tags

    filterTagNotIn string[]

    Filter keys not tagged by one of provided tags

    format stringrequired

    Possible values: [JSON, JSON_TOLGEE, XLIFF, PO, APPLE_STRINGS_STRINGSDICT, APPLE_XLIFF, ANDROID_XML, COMPOSE_XML, FLUTTER_ARB, PROPERTIES, YAML_RUBY, YAML, JSON_I18NEXT, CSV, RESX_ICU, XLSX, APPLE_XCSTRINGS]

    Format to export to

    id int64required
    languages string[]

    Languages to be contained in export.

    If null, all languages are exported

    lastPublished int64
    lastPublishedFiles string[]required
    messageFormat string

    Possible values: [C_SPRINTF, PHP_SPRINTF, JAVA_STRING_FORMAT, APPLE_SPRINTF, RUBY_SPRINTF, I18NEXT, ICU, PYTHON_PERCENT]

    Message format to be used for export.

    e.g. PHP_PO: Hello %s, ICU: Hello {name}.

    This property is honored only for generic formats like JSON or YAML. For specific formats like YAML_RUBY it's ignored.

    name stringrequired
    pruneBeforePublish booleanrequired
    publicUrl string
    slug stringrequired
    storage object
    azureContentStorageConfig object
    containerName string
    id int64required
    name stringrequired
    publicUrlPrefix string
    s3ContentStorageConfig object
    bucketName stringrequired
    endpoint stringrequired
    signingRegion stringrequired
    structureDelimiter string

    Delimiter to structure file content.

    e.g. For key "home.header.title" would result in {"home": {"header": "title": {"Hello"}}} structure.

    When null, resulting file won't be structured. Works only for generic structured formats (e.g. JSON, YAML), specific formats like YAML_RUBY don't honor this parameter.

    supportArrays booleanrequired

    If true, for structured formats (like JSON) arrays are supported.

    e.g. Key hello[0] will be exported as {"hello": ["..."]}

Loading...