Tolgee Octri Demo
POST/v2/administration/projects/{projectId}/import

Import a project from an export ZIP

Imports an export ZIP into a project, replacing all in-scope project content.

This import wipes existing in-scope content; keep the project free of concurrent edits during the import.
Use an export from the same Tolgee version; setting ignoreVersion bypasses the version check and can silently corrupt project data, while content from users not found by username is attributed to the importing admin.

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

2 parameters · 1 body field
projectIdintegerrequired
The unique integer identifier of the project to replace with the imported content.
ignoreVersionbooleanoptional
Bypasses the export schema-version check. Defaults to false when omitted; using true for a cross-version import is unsupported and may silently corrupt project data.
Default:false

Multipart form data containing the project export ZIP.

filestringrequired
The project export ZIP to import. The archive must come from an instance running the same Tolgee version unless you use the unsupported `ignoreVersion` option.

5 status codes
200Confirms that the project import completed.
400Returned when the request or uploaded project export cannot be processed.
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 import projects.
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 specified project is not 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 or import file is invalid. A 401 is returned when the request is unauthenticated, a 403 when the authenticated user is not permitted to import projects, and a 404 when the project is not found. The projectId path parameter must identify the target project, and the multipart request must include file; use an export from the same Tolgee version unless you accept the unsupported data-corruption risk of ignoreVersion.