Pausing Monitor - Galtea Docs

Returns

Returns the paused Monitor. A paused monitor scores nothing until you resume it, and it keeps its configuration. Sessions that close while it is paused are skipped for good. Pausing works from any status. Pausing a monitor that is already paused returns it unchanged. The API refuses the call when the monitor does not exist or you cannot edit it.

Example

# Stop scoring until the monitor is resumed. The monitor keeps its configuration.
paused_monitor = galtea.monitors.pause(monitor.id)

Parameters

string

required

The ID of the monitor to pause.