Skip to content

Version Management

Safely promote changes between tenant environments. With Version Management APIs, you can export, validate, import, and force-import tenant configurations while ensuring version and integrity checks.

Download OpenAPI description
version-management.openapi.json
version-management.openapi.yaml
Languages
Servers
Sandbox environment
https://version-management.sbx.transmitsecurity.io/
Production environment (US)
https://version-management.transmitsecurity.io/
Production environment (CA)
https://version-management.ca.transmitsecurity.io/
Production environment (EU)
https://version-management.eu.transmitsecurity.io/
Production environment (AU)
https://version-management.au.transmitsecurity.io/

Export configuration

Request

Export the full configuration of the specified tenant in JSON or ZIP format.

Security
bearer
Path
tenantIdstringrequired

Tenant ID specifying the environment from which the configuration is exported

Query
formatstringrequired

Exported data format

Enum"json""zip"
curl -i -X GET \
  'https://version-management.sbx.transmitsecurity.io/version/export/{tenantId}?format=json' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Export completed. Returns the exported tenant configuration payload, including application data, external connections, and alias references.

Bodyapplication/json
versionstringrequired

Version tag of the exported configuration

applicationobjectrequired
application.​pathstringrequired

The path to the resource

application.​dataobjectrequired

The data of the resource

application.​categorystringrequired

The category of the resource

application.​typestringrequired

The type of the resource

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

external_connections_and_typed_lists[].​pathstringrequired

The path to the resource

external_connections_and_typed_lists[].​dataobjectrequired

The data of the resource

external_connections_and_typed_lists[].​categorystringrequired

The category of the resource

external_connections_and_typed_lists[].​typestringrequired

The type of the resource

keys_aliasobjectrequired
keys_alias.​aliasstringrequired

Alias of the referenced resource. Must match an existing resource alias in the target tenant

keys_alias.​versionstringrequired

Version identifier of the referenced resource. Used to ensure compatibility during import

credentials_aliasobjectrequired
credentials_alias.​aliasstringrequired

Alias of the referenced resource. Must match an existing resource alias in the target tenant

credentials_alias.​versionstringrequired

Version identifier of the referenced resource. Used to ensure compatibility during import

certificates_aliasobjectrequired
certificates_alias.​aliasstringrequired

Alias of the referenced resource. Must match an existing resource alias in the target tenant

certificates_alias.​versionstringrequired

Version identifier of the referenced resource. Used to ensure compatibility during 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

Response
application/json
{
  "version": "string",
  "application": {
    "path": "string",
    "data": {},
    "category": "string",
    "type": "string"
  },
  "external_connections_and_typed_lists": [
    { … }
  ],
  "keys_alias": {
    "alias": "string",
    "version": "string"
  },
  "credentials_alias": {
    "alias": "string",
    "version": "string"
  },
  "certificates_alias": {
    "alias": "string",
    "version": "string"
  },
  "environment_variables_alias": [
    "string"
  ]
}

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
formatstringrequired

Expected format of the file to import

Enum"json""zip"
Bodyapplication/jsonrequired

Exported data to import

versionstringrequired

Version tag of the exported configuration

applicationobjectrequired
application.​pathstringrequired

The path to the resource

application.​dataobjectrequired

The data of the resource

application.​categorystringrequired

The category of the resource

application.​typestringrequired

The type of the resource

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

external_connections_and_typed_lists[].​pathstringrequired

The path to the resource

external_connections_and_typed_lists[].​dataobjectrequired

The data of the resource

external_connections_and_typed_lists[].​categorystringrequired

The category of the resource

external_connections_and_typed_lists[].​typestringrequired

The type of the resource

keys_aliasobjectrequired
keys_alias.​aliasstringrequired

Alias of the referenced resource. Must match an existing resource alias in the target tenant

keys_alias.​versionstringrequired

Version identifier of the referenced resource. Used to ensure compatibility during import

credentials_aliasobjectrequired
credentials_alias.​aliasstringrequired

Alias of the referenced resource. Must match an existing resource alias in the target tenant

credentials_alias.​versionstringrequired

Version identifier of the referenced resource. Used to ensure compatibility during import

certificates_aliasobjectrequired
certificates_alias.​aliasstringrequired

Alias of the referenced resource. Must match an existing resource alias in the target tenant

certificates_alias.​versionstringrequired

Version identifier of the referenced resource. Used to ensure compatibility during 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/import/{tenantId}?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

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

Bodyapplication/json
statusstringrequired

Overall status of the import process

Enum"success""failure""not applicable"
detailsstringrequired

Detailed import result

Enum"Import completed successfully""Force import completed successfully""Import failed""Force import failed""Import body is empty""Not applicable"
Response
application/json
{
  "status": "success",
  "details": "Import completed successfully"
}

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
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.​pathstringrequired

The path to the resource

application.​dataobjectrequired

The data of the resource

application.​categorystringrequired

The category of the resource

application.​typestringrequired

The type of the resource

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

external_connections_and_typed_lists[].​pathstringrequired

The path to the resource

external_connections_and_typed_lists[].​dataobjectrequired

The data of the resource

external_connections_and_typed_lists[].​categorystringrequired

The category of the resource

external_connections_and_typed_lists[].​typestringrequired

The type of the resource

keys_aliasobjectrequired
keys_alias.​aliasstringrequired

Alias of the referenced resource. Must match an existing resource alias in the target tenant

keys_alias.​versionstringrequired

Version identifier of the referenced resource. Used to ensure compatibility during import

credentials_aliasobjectrequired
credentials_alias.​aliasstringrequired

Alias of the referenced resource. Must match an existing resource alias in the target tenant

credentials_alias.​versionstringrequired

Version identifier of the referenced resource. Used to ensure compatibility during import

certificates_aliasobjectrequired
certificates_alias.​aliasstringrequired

Alias of the referenced resource. Must match an existing resource alias in the target tenant

certificates_alias.​versionstringrequired

Version identifier of the referenced resource. Used to ensure compatibility during 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}?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

Overall status of the import process

Enum"success""failure""not applicable"
detailsstringrequired

Detailed import result

Enum"Import completed successfully""Force import completed successfully""Import failed""Force import failed""Import body is empty""Not applicable"
Response
application/json
{
  "status": "success",
  "details": "Import completed successfully"
}

Validate structure

Request

Validate the structure and version of exported data without applying it to the target tenant

Security
bearer
Path
tenantIdstringrequired

Tenant ID specifying the environment against which the exported data is validated

Query
formatstringrequired

Format of data to validate

Enum"json""zip"
Bodyapplication/jsonrequired

Exported data to validate

versionstringrequired

Version tag of the exported configuration

applicationobjectrequired
application.​pathstringrequired

The path to the resource

application.​dataobjectrequired

The data of the resource

application.​categorystringrequired

The category of the resource

application.​typestringrequired

The type of the resource

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

external_connections_and_typed_lists[].​pathstringrequired

The path to the resource

external_connections_and_typed_lists[].​dataobjectrequired

The data of the resource

external_connections_and_typed_lists[].​categorystringrequired

The category of the resource

external_connections_and_typed_lists[].​typestringrequired

The type of the resource

keys_aliasobjectrequired
keys_alias.​aliasstringrequired

Alias of the referenced resource. Must match an existing resource alias in the target tenant

keys_alias.​versionstringrequired

Version identifier of the referenced resource. Used to ensure compatibility during import

credentials_aliasobjectrequired
credentials_alias.​aliasstringrequired

Alias of the referenced resource. Must match an existing resource alias in the target tenant

credentials_alias.​versionstringrequired

Version identifier of the referenced resource. Used to ensure compatibility during import

certificates_aliasobjectrequired
certificates_alias.​aliasstringrequired

Alias of the referenced resource. Must match an existing resource alias in the target tenant

certificates_alias.​versionstringrequired

Version identifier of the referenced resource. Used to ensure compatibility during 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/validate/{tenantId}?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

Validation completed. Returns validation result and any detected errors

Bodyapplication/json
isValidbooleanrequired

Indicates if the validation was successful

errorsArray of objectsrequired

List of validation errors

errors[].​typestringrequired

Type of validation error

Enum"VERSION_MISMATCH""MISSING_CREDENTIALS""MISSING_CERTIFICATES""MISSING_KEYS""MISSING_ENVIRONMENT_VARIABLES""EMPTY_EXPORT_DATA""INVALID_IDO_STRUCTURE""ZIP_FILE_SIZE_LIMIT_EXCEEDED""INVALID_AUTHENTICATION_AND_USER_MANAGEMENT_INPUT"
errors[].​messagestringrequired

Error message

errors[].​detailsArray of stringsrequired

Error details

Response
application/json
{
  "isValid": true,
  "errors": [
    { … }
  ]
}