get_live_operators

List all live operators (operator-control view of running channels).

get_live_operators

List all live operators (operator-control view of running channels).

List every live operator. The operator surface is the run-time control view used to broadcast/clip segments on a live channel.

Safety class: A · API type: admin · Min version:

📘

Confinement

Read-only; safe anywhere. Operators are account-global, not folder-confined.

Signatures

def get_live_operators(sdk):
    """Return the live operators collection (or None)."""
    return sdk.get_live_operators()
export async function getLiveOperators(sdk) {
    return await sdk.getLiveOperators();
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyesadmin-apiType client

Returns

dict | None — collection of live operator objects; each has channel configuration, status, and metadata. See return-shapes.md.

Errors

  • 401 unauthenticated
  • InvalidAPITypeException if session is not admin

Notes

Real-world usage

  • Maps to GET /admin/liveOperator; lists operators, each mirroring a channel's run-time status and exposing segment/broadcast controls.
  • Operator id equals the live channel id it controls — pass a channel id to get_live_operator.

Requires an admin session (raises InvalidAPITypeException otherwise).

Real-world usage

  • Maps to GET /admin/liveOperator; lists operators, each mirroring a channel's run-time status and exposing segment/broadcast controls.
  • An operator id equals the live channel id it controls — pass a channel id to getLiveOperator.

Requires an admin session (raises InvalidAPITypeException otherwise).

See also: Python ↔ JS naming map · Return shapes.