Version Management

Download OpenAPI specification:Download

The Version Management Service provides APIs to export, validate, import, and force-import tenant configurations. Use it to migrate settings between environments while ensuring version and integrity checks.

Export configuration

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

SecurityHTTP: bearer
Request
path Parameters
tenantId
required
string

Tenant ID specifying the environment from which the configuration is exported

query Parameters
format
required
string

Exported data format

Enum: "json" "zip"
Responses
201

Export completed

400

Error - Bad Request

401

Error - Unauthorized

500

Error - Internal Server Error

post/version/export/{tenantId}
Request samples 
Response samples 
application/json
{
  • "version": "string",
  • "application": {
    },
  • "external_connections_and_typed_lists": [
    ],
  • "keys_alias": [
    ],
  • "credentials_alias": [
    ],
  • "certificates_alias": [
    ],
  • "environment_variables_alias": [
    ]
}
Import configuration
Import tenant configuration data with version and integrity validation.


SecurityHTTP: bearer 
Request 
path Parameters
tenantId
required
string
Tenant ID specifying the environment into which the configuration is imported


 
query Parameters
format
required
string
Expected format of the file to import


 Enum: "json" "zip"  
Request Body schema: application/json
required
Exported data to import


version
required
string
Version tag of the exported configuration


 
required
object
Application export data


 
required
Array of objects (IdoExportDataResponseDto) 
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


 
required
Array of objects (IdentityData) 
List of key aliases referenced by the export. These keys must already exist in the target tenant before import


 
required
Array of objects (IdentityData) 
List of credential aliases referenced by the export. These credentials must already exist in the target tenant before import


 
required
Array of objects (IdentityData) 
List of certificate aliases referenced by the export. These certificates must already exist in the target tenant before import


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


 
Responses 
201
Import completed


400
Error - Bad Request


401
Error - Unauthorized


500
Error - Internal Server Error


post/version/import/{tenantId}
Request samples 
application/json
{
  • "version": "string",
  • "application": {
    },
  • "external_connections_and_typed_lists": [
    ],
  • "keys_alias": [
    ],
  • "credentials_alias": [
    ],
  • "certificates_alias": [
    ],
  • "environment_variables_alias": [
    ]
}
Response samples 
application/json
{
  • "status": "success",
  • "details": "Import completed"
}
Force import
Force import tenant configuration, skipping version checks but validating structural integrity.


SecurityHTTP: bearer 
Request 
path Parameters
tenantId
required
string
Tenant ID specifying the environment into which the configuration is force-imported


 
query Parameters
format
required
string
Expected format of the file to import


 Enum: "json" "zip"  
Request Body schema: application/json
required
Exported data to force import


version
required
string
Version tag of the exported configuration


 
required
object
Application export data


 
required
Array of objects (IdoExportDataResponseDto) 
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


 
required
Array of objects (IdentityData) 
List of key aliases referenced by the export. These keys must already exist in the target tenant before import


 
required
Array of objects (IdentityData) 
List of credential aliases referenced by the export. These credentials must already exist in the target tenant before import


 
required
Array of objects (IdentityData) 
List of certificate aliases referenced by the export. These certificates must already exist in the target tenant before import


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


 
Responses 
201
Force import completed


400
Error - Bad Request


401
Error - Unauthorized


500
Error - Internal Server Error


post/version/force-import/{tenantId}
Request samples 
application/json
{
  • "version": "string",
  • "application": {
    },
  • "external_connections_and_typed_lists": [
    ],
  • "keys_alias": [
    ],
  • "credentials_alias": [
    ],
  • "certificates_alias": [
    ],
  • "environment_variables_alias": [
    ]
}
Response samples 
application/json
{
  • "status": "success",
  • "details": "Import completed"
}
Validate structure
Validate the structure and version of exported data without applying it to the target tenant


SecurityHTTP: bearer 
Request 
path Parameters
tenantId
required
string
Tenant ID specifying the environment against which the exported data is validated


 
query Parameters
format
required
string
Format of data to validate


 Enum: "json" "zip"  
Request Body schema: application/json
required
Exported data to validate


version
required
string
Version tag of the exported configuration


 
required
object
Application export data


 
required
Array of objects (IdoExportDataResponseDto) 
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


 
required
Array of objects (IdentityData) 
List of key aliases referenced by the export. These keys must already exist in the target tenant before import


 
required
Array of objects (IdentityData) 
List of credential aliases referenced by the export. These credentials must already exist in the target tenant before import


 
required
Array of objects (IdentityData) 
List of certificate aliases referenced by the export. These certificates must already exist in the target tenant before import


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


 
Responses 
201
Validation completed


400
Error - Bad Request


401
Error - Unauthorized


500
Error - Internal Server Error


post/version/validate/{tenantId}
Request samples 
application/json
{
  • "version": "string",
  • "application": {
    },
  • "external_connections_and_typed_lists": [
    ],
  • "keys_alias": [
    ],
  • "credentials_alias": [
    ],
  • "certificates_alias": [
    ],
  • "environment_variables_alias": [
    ]
}
Response samples 
application/json
{
  • "isValid": true,
  • "errors": [
    ]
}
Get service health status
Returns the service version and health status.


Responses 
200
Service health status


500
Error - Internal Server Error


get/health
Request samples 
Response samples 
application/json
{
  • "version": "string",
  • "status": "string"
}
Get Prometheus metrics
Get Prometheus metrics in text format


Responses 
200
Prometheus metrics output


500
Error - Internal Server Error


get/metrics
Request samples 
Response samples 
application/json
{
  • "statusCode": 500,
  • "message": "Internal server error"
}