Skip to main content

Update Content Delivery Config

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

Update Content Delivery Config

Request​

Path Parameters

    id int64required
    projectId int64required

Body

required
    name stringrequired
    contentStorageId int64

    Id of custom storage to use for content delivery. If null, default server storage is used. Tolgee Cloud provides default Content Storage.

    autoPublish booleanrequired

    If true, data are published to the content delivery automatically after each change.

    slug string

    Possible values: non-empty and <= 60 characters

    Tolgee uses a custom slug as a directory name for content storage and public content delivery URL. It is only applicable for custom storage. This field needs to be kept null for Tolgee Cloud content storage or global server storage on self-hosted instances.

    Slag has to match following regular expression: ^[a-z0-9]+(?:-[a-z0-9]+)*$.

    If null is provided for update operation, slug will be assigned with generated value.

    pruneBeforePublish booleanrequired

    Whether the data in the CDN should be pruned before publishing new data.

    In some cases, you might want to keep the data in the storage and only replace the files created by following publish operation.

    languages string[]

    Languages to be contained in export.

    If null, all languages are exported

    format stringrequired

    Possible values: [JSON, JSON_TOLGEE, XLIFF, PO, APPLE_STRINGS_STRINGSDICT, APPLE_XLIFF, ANDROID_XML, FLUTTER_ARB, PROPERTIES, YAML_RUBY, YAML]

    Format to export to

    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": ["..."]}

    filterKeyId int64[]

    Filter key IDs to be contained in export

    filterKeyIdNot int64[]

    Filter key IDs not to be contained in export

    filterTag string

    Filter keys tagged by

    filterKeyPrefix string

    Filter keys with prefix

    filterState string[]

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

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

    filterNamespace string[]

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

    messageFormat string

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

    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.

Responses​

OK

Schema
    id int64required
    name stringrequired
    slug stringrequired
    pruneBeforePublish booleanrequired
    storage object
    id int64required
    name stringrequired
    publicUrlPrefix string
    azureContentStorageConfig object
    containerName string
    s3ContentStorageConfig object
    bucketName stringrequired
    endpoint stringrequired
    signingRegion stringrequired
    publicUrl string
    autoPublish booleanrequired
    lastPublished int64
    languages string[]

    Languages to be contained in export.

    If null, all languages are exported

    format stringrequired

    Possible values: [JSON, JSON_TOLGEE, XLIFF, PO, APPLE_STRINGS_STRINGSDICT, APPLE_XLIFF, ANDROID_XML, FLUTTER_ARB, PROPERTIES, YAML_RUBY, YAML]

    Format to export to

    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.

    filterKeyId int64[]

    Filter key IDs to be contained in export

    filterKeyIdNot int64[]

    Filter key IDs not to be contained in export

    filterTag string

    Filter keys tagged by

    filterKeyPrefix string

    Filter keys with prefix

    filterState string[]

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

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

    filterNamespace string[]

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

    messageFormat string

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

    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.

    supportArrays booleanrequired

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

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

Loading...