Skip to content

Force import

Request

Force import tenant configuration, skipping version checks but validating structural integrity.

Security
bearer
Path
tenantIdstringrequired

Tenant ID specifying the environment into which the configuration is force-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

Expected format of the file to import

Enum:"json""zip"
Bodyapplication/jsonrequired

Exported data to force import

versionstringrequired

Version tag of the exported configuration

applicationobjectrequired

Application export data

external_connections_and_typed_listsArray of objectsrequired

External connections and typed lists referenced by the export. These references are not exported secrets and must resolve to existing resources in the target tenant

keys_aliasobjectrequired

List of key aliases referenced by the export. These keys must already exist in the target tenant before import

credentials_aliasobjectrequired

List of credential aliases referenced by the export. These credentials must already exist in the target tenant before import

certificates_aliasobjectrequired

List of certificate aliases referenced by the export. These certificates must already exist in the target tenant before import

environment_variables_aliasArray of stringsrequired

List of environment variable aliases referenced by the export. These environment variables must already exist in the target tenant before import

curl -i -X POST \
  'https://version-management.sbx.transmitsecurity.io/version/force-import/{tenantId}?failureRollBack=true&format=json' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "version": "string",
    "application": {
      "path": "string",
      "data": {},
      "category": "string",
      "type": "string"
    },
    "external_connections_and_typed_lists": [
      {
        "path": "string",
        "data": {},
        "category": "string",
        "type": "string"
      }
    ],
    "keys_alias": {
      "alias": "string",
      "version": "string"
    },
    "credentials_alias": {
      "alias": "string",
      "version": "string"
    },
    "certificates_alias": {
      "alias": "string",
      "version": "string"
    },
    "environment_variables_alias": [
      "string"
    ]
  }'

Responses

Force import completed successfully

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"
  }
}