Use the POST /configArchive/import endpoint to import a configuration archive. If there are missing components or license inconsistencies, the import is halted by default to allow you to install the necessary components or license. However, you can choose to force the deployment by setting forceImport to true and then installing the necessary files later.

POST/configArchive/import?forceImport=<boolean>

Query parameters

Parameter Value Description
forceImport boolean Set to true to force import without pre-installing required assets.

Status codes

Code Reason
200 Configuration Archive imported.
422 Validation error(s) occurred.

ApiResult - Details on the result of the operation.

Property Type Description
developerMessage string Developer-oriented error message, if available.
message string Success or error message.
resultId string Result identifier.
validationErrors array[ValidationError] List of validation errors, if any.

ValidationError - A data input validation error.

Property Type Description
developerMessage string Developer-oriented error message, if available.
errorId string Error identifier.
fieldPath string The path to the model field to which the error relates, if one exists.
message string User-friendly error description.