Skip to content

controls

Runtime operator controls: temporary overrides of configured switches.

A control's configured value is the platform's default and its permanent setting. An operator can override it for a bounded time — during an incident, with a reason — and the override expires on its own. Reading a control returns all three: what is configured, what is overridden, what is in force.

PlatformControlOut pydantic-model

Bases: BaseModel

One control: configured default, override if any, and what is in force.

Fields:

configured pydantic-field

The configured value — the default.

effective pydantic-field

The value the platform is applying right now: the override while it lasts, else the configured value.

override = None pydantic-field

The live override, or null when none is in force.

PlatformControlOverride pydantic-model

Bases: BaseModel

An operator's override of a control, while it lasts.

Config:

  • from_attributes: True

Fields:

enabled pydantic-field

The overriding value.

expires_at pydantic-field

When the configured value takes over again.

reason pydantic-field

Why the operator set it.

set_at pydantic-field

When it was set.

set_by pydantic-field

The administrator who set it.

PlatformControlUpdate pydantic-model

Bases: BaseModel

Set a control's override.

Every override expires; the server bounds how far ahead expires_at may lie. Setting a control that already has an override replaces it, which is also how an override is extended.

Fields:

enabled pydantic-field

The value to apply until expiry.

expires_at pydantic-field

When the override ends and the configured value returns. Must lie in the future, within the server's maximum override length.

reason pydantic-field

Why. Recorded with the change and shown to other administrators.

PlatformControlsOut pydantic-model

Bases: BaseModel

Every known control.

Fields: