Skip to content

Get backend version and build information

GET
/api/system/status/version

Get backend version and build information for deployment tracking.

Provides comprehensive version information for the backend service including backend version, status routes module version, build date, Python runtime version, and current environment. Useful for debugging, monitoring dashboards, deployment verification, and ensuring correct version consistency across environments.

Returns:

  • VersionResponse: Version information with the following fields:
    • version: Backend semantic version number (e.g., “5.0.0”)
    • module_version: Status routes module version
    • build_date: Build date in YYYY-MM-DD format
    • python_version: Python runtime version (e.g., “3.11.5”)
    • environment: Current environment (development/production/staging)

Raises:

  • HTTPException(500): If version information cannot be retrieved

Use Cases:

  • Deployment Verification: Confirm correct version deployed to production
  • Debugging: Include version in error reports for support
  • Monitoring: Track version across multiple instances
  • Compatibility: Verify Python version requirements met
  • Release Management: Version tracking and rollback verification

Example Response:

{
    "version": "5.0.0",
    "moduleVersion": "5.0.0",
    "buildDate": "2025-02-01",
    "pythonVersion": "3.11.5",
    "environment": "production"
}

Note: Version follows semantic versioning (MAJOR.MINOR.PATCH)

Successful Response

VersionResponse

Version information response for deployment tracking and debugging.

Provides comprehensive version information including backend version, module version, build date, Python runtime, and environment.

Fields: version: Backend version number (semantic versioning) module_version: Status routes module version build_date: Build date in YYYY-MM-DD format python_version: Python runtime version (e.g., “3.11.5”) environment: Current environment (development/production/staging)

object
version
required
Version
string
moduleVersion
required
Moduleversion
string
buildDate
required
Builddate
string
pythonVersion
required
Pythonversion
string
environment
required
Environment
string