Tolgee Octri Demo
POST/v2/projects/{projectId}/content-storages/test

Test content storage settings

Tests content storage settings for a project without creating a storage configuration. Supply name and the settings for the provider you want to test; required nested settings depend on whether you use Azure or S3. A 200 response reports whether the test succeeded and can include a message.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 4 body fields
projectIdintegerrequired
The numeric identifier of the project whose content storage settings you want to test.

Content storage name, optional public URL prefix, and configuration for the storage provider. Supply name; include the provider configuration you need.

azureContentStorageConfigobjectoptional
Azure storage settings, including the required `containerName` and optional `connectionString`.
namestringrequired
The content storage name. Must be no more than 100 characters.
publicUrlPrefixstringoptional
The public URL prefix for stored content. Must be no more than 255 characters.
s3ContentStorageConfigobjectoptional
S3-compatible storage settings. `bucketName`, `endpoint`, `path`, `publicRead`, and `signingRegion` are required; `accessKey` and `secretKey` are also available.

5 status codes
200Returns a result containing a `success` boolean and, when available, a message describing the test outcome.
messagestringoptional
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
successbooleanrequired
400Returned when the request body is invalid or a required field or nested provider setting is missing.
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 is not permitted to test content storage settings for the project.
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 does not exist.
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 when authentication is missing or invalid, a 403 when access is forbidden, and a 404 when the project is not found. name is required; containerName is required in azureContentStorageConfig, and bucketName, endpoint, path, publicRead, and signingRegion are required in s3ContentStorageConfig. The projectId path parameter must identify an existing project.