Skip to content

Get comprehensive system configuration

GET
/api/system/system-config/configuration

Get comprehensive system configuration.

Provides comprehensive system configuration including paths, ports, and status. This is the single source of truth for all system configuration.

Args: path_manager: Injected path manager for file path resolution.

Returns: Dictionary containing paths, ports, port health, and timestamp.

Raises: HTTPException: If configuration retrieval fails.

Successful Response

MonitoringSystemConfigurationResponse

Response model for monitoring /configuration endpoint

object
paths
required
Paths
object
key
additional properties
string
ports
required

Arbitrary JSON-shaped data. Flattened from a recursive type alias for wiki rendering — the live API accepts any JSON-compatible value (string, number, bool, null, array, or nested object).

object
key
additional properties
any
portManagerHealth
required

Arbitrary JSON-shaped data. Flattened from a recursive type alias for wiki rendering — the live API accepts any JSON-compatible value (string, number, bool, null, array, or nested object).

object
key
additional properties
any
timestamp
required
Timestamp
string