SystemStatus

SystemStatus aggregates the real-time service status information exposed by Werk24. It combines incidents, maintenance windows, and component states into a single snapshot so you can evaluate platform availability quickly. The model includes timestamps, overall status summaries, helpful links for more information, and metadata about the data source. Applications can use it to display health banners, block requests when critical services are down, or feed monitoring dashboards. Because the object nests the detailed incident and component objects, you gain a holistic view that supports compliance reporting and customer communication in one payload while also enabling historical trend analysis and capacity planning.

Bases: BaseModel

Overall system status returned by the status endpoint.

PARAMETER	DESCRIPTION
`page`	TYPE: `str \| None` DEFAULT: `None`
`status_indicator`	TYPE: `str`
`status_description`	TYPE: `str \| None` DEFAULT: `None`
`incidents`	Built-in mutable sequence. If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified. TYPE: `List[SystemStatusIncident]` DEFAULT: `<dynamic>`
`scheduled_maintenances`	Built-in mutable sequence. If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified. TYPE: `List[SystemStatusMaintenance]` DEFAULT: `<dynamic>`
`components`	Built-in mutable sequence. If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified. TYPE: `List[SystemStatusComponent]` DEFAULT: `<dynamic>`

Source code in werk24/models/v2/status.py

class SystemStatus(BaseModel):
    """Overall system status returned by the status endpoint."""

    page: Optional[str] = None
    status_indicator: str
    status_description: Optional[str] = None
    incidents: List[SystemStatusIncident] = Field(default_factory=list)
    scheduled_maintenances: List[SystemStatusMaintenance] = Field(default_factory=list)
    components: List[SystemStatusComponent] = Field(default_factory=list)