Skip to content

Get basic system information and service status

GET
/api/system/status/info

Get basic system information and service status for quick overview.

Provides quick overview of system state including service name, version, uptime, and current status. Status is automatically determined based on startup state: ‘failed’ if startup failed, ‘starting’ if not complete, or ‘running’ if fully initialized. Useful for monitoring dashboards, quick health checks, and system administration panels.

Returns:

  • SystemInfoResponse: System information with the following fields:
    • service_name: Human-readable service name
    • version: Backend version number
    • uptime_seconds: Service uptime in seconds since startup
    • status: Current system status (failed/starting/running)
    • timestamp: Current server timestamp when info gathered

Raises:

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

Status Values:

  • ‘failed’: Startup sequence encountered a fatal error
  • ‘starting’: Backend is still initializing
  • ‘running’: Backend is fully operational

Use Cases:

  • Dashboard Header: Display service status and uptime
  • Monitoring: Track service availability and runtime
  • Administration: Quick service health overview
  • Debugging: Include in error reports for context
  • Status Indicators: Show system state in UI

Example Response:

{
    "serviceName": "Ishvana DivinityEngine",
    "version": "5.0.0",
    "uptimeSeconds": 3600.5,
    "status": "running",
    "timestamp": "2025-02-01T10:30:00Z"
}

Note: Uptime is calculated from service start time, not system boot time.

Successful Response

SystemInfoResponse

Basic system information response for quick status overview.

Provides essential system state information including service name, version, uptime, and current status for dashboard displays and monitoring.

Fields: service_name: Human-readable service name version: Backend version number uptime_seconds: Service uptime in seconds since startup status: Current system status (‘failed’/‘starting’/‘running’) timestamp: Current server timestamp when info was gathered

object
serviceName
required
Servicename
string
version
required
Version
string
uptimeSeconds
required
Uptimeseconds
number
status
required
Status
string
timestamp
required
Timestamp
string format: date-time