Skip to content

SystemStatus

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)