Import configuration

Request

Import tenant configuration data with version and integrity validation.

Security

bearer

Path

tenantIdstringrequired

Tenant ID specifying the environment into which the configuration is imported

Query

failureRollBackboolean

If true, the system will attempt to revert the target tenant to its state before the import when the import fails or only partially completes (e.g. one module import succeeds but another fails).

formatstringrequired

Format of the package to import: zip archive or json payload.

Enum:"json""zip"

Body

required

Exported package to import, as a ZIP archive or a JSON payload

string, (binary)

curl -i -X POST \
  'https://version-management.sbx.transmitsecurity.io/version/import/{tenantId}?failureRollBack=true&format=json' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/zip' \
  -d string

Responses

Import completed successfully. Returns the overall status and details of the import process

Bodyapplication/json

statusstringrequired

Response status indicator

Enum:"success""failure""not applicable"

messagestringrequired

Import result message

Enum:"Import completed successfully""Force import completed successfully""Import failed""Force import failed""Import failed; attempted to rollback from backup""Rollback completed successfully""Rollback from backup failed""Import body is empty""Import already in progress""Not applicable"

detailsobject

Optional detailed error information

rollbackResultobject

Result of the restore-from-backup when import failed and rollback succeeded

Response

{
  "status": "success",
  "message": "Import completed successfully",
  "details": {},
  "rollbackResult": {
    "status": "success",
    "message": "Import completed successfully"
  }
}