Tolgee Octri Demo
GET/v2/projects/{projectId}/content-delivery-configs/{id}

Get a content delivery configuration

Retrieves a content delivery configuration from a project. Use projectId and id to identify the configuration whose settings you need.

2 parameters
idintegerrequired
The integer identifier of the content delivery configuration to retrieve.
projectIdintegerrequired
The integer identifier of the project containing the configuration.

5 status codes
200Returns the content delivery configuration, including its identifier, export format, filters, file structure settings, and publishing details.
autoPublishbooleanrequired
branchNamestringoptional
Branch name this CDN config is associated with. Null means default branch or no branching.
escapeHtmlbooleanoptional
If true, HTML tags are escaped in the exported file. (Supported in the XLIFF format only). e.g. Key <b>hello</b> will be exported as &lt;b&gt;hello&lt;/b&gt;
fileStructureTemplatestringoptional
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)
filterBranchstringoptional
Filter translations with branch. By default, default branch is exported.
filterKeyIdarray<integer>optional
Filter key IDs to be contained in export
filterKeyIdNotarray<integer>optional
Filter key IDs not to be contained in export
filterKeyPrefixstringoptional
Filter keys with prefix
filterNamespacearray<string>optional
Filter translations with namespace. By default, all namespaces everything are exported. To export default namespace, use empty string.
filterStatearray<string>optional
Filter translations with state. By default, all states except untranslated is exported.
filterTagstringoptional
Filter keys tagged by. This filter works the same as `filterTagIn` but in this cases it accepts single tag only.
filterTagInarray<string>optional
Filter keys tagged by one of provided tags
filterTagNotInarray<string>optional
Filter keys not tagged by one of provided tags
formatstringrequired
Format to export to
Allowed:JSONJSON_TOLGEEXLIFFPOAPPLE_STRINGS_STRINGSDICTAPPLE_XLIFFANDROID_XMLCOMPOSE_XMLFLUTTER_ARBPROPERTIESYAML_RUBYYAML
idintegerrequired
languagesarray<string>optional
Languages to be contained in export. If null, all languages are exported
lastPublishedintegeroptional
lastPublishedFilesarray<string>required
messageFormatstringoptional
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.
Allowed:C_SPRINTFPHP_SPRINTFJAVA_STRING_FORMATAPPLE_SPRINTFRUBY_SPRINTFI18NEXTICUPYTHON_PERCENTPYTHON_BRACE
namestringrequired
pruneBeforePublishbooleanrequired
publicUrlstringoptional
slugstringrequired
storageobjectoptional
structureDelimiterstringoptional
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.
supportArraysbooleanrequired
If true, for structured formats (like JSON) arrays are supported. e.g. Key hello[0] will be exported as {"hello": ["..."]}
zipbooleanrequired
400Returned when the request is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user does not have permission to view the configuration.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the project or configuration cannot be found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request is invalid. A 401 is returned when the request is unauthenticated, and a 403 is returned when the authenticated user lacks permission to view the configuration. A 404 is returned when the project or configuration cannot be found. The id and projectId path parameters must identify the configuration and its project.