get_live_channels

List all live channels (account-wide) with full config and status.

List every live channel on the deployment. The response is a plain array, not a
{items} envelope - iterate it directly.

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

📘

Confinement

Read-only. Channels are account-global, NOT folder-confined; reads are safe anywhere but mutations (start/stop) are Class C - non-prod only.

Signatures

def get_live_channels(sdk):
    """Return the list of live channel dicts (or None). Status is nested:
    channel['status']['description'] (e.g. 'Running'); see enums.md."""
    return sdk.get_live_channels()

export async function getLiveChannels(sdk) {
    // Status is nested: channel.status.description (e.g. "Running"); see enums.md.
    return await sdk.getLiveChannels();
}

Parameters

Returns

list[dict] | None - ARRAY of channel objects (not {items}). Each carries id, name, status{id,description}, statusMessage, type, scheduleEvents, outputs, associatedInputs. See return-shapes.md + enums.md.

Errors

• 401 unauthenticated
• InvalidAPITypeException if session is not admin

Notes

Real-world usage

• GET /api/liveChannel (this verb) returns the live-channel list. Read
  status.description / statusName for the status and type for the channel type.
• A channel's lifecycle status lives under status as {id, description} where id is a
  LiveChannelStatusLookup UUID and description is the status name (Idle, Running,
  Starting, Stopping, Error, …). Map names/ints via reference/enums.md.
• To act on one channel, resolve it by name from this list, then pass its id to
  get_live_channel, start_live_channel, or stop_live_channel.

Requires an admin session - the SDK raises InvalidAPITypeException on a portal
session (see reference/api-types.md).

Real-world usage

• Maps to GET /api/liveChannel. Read status.description / statusName for the status
  and type for the channel type.
• Status lives under status as {id, description} where id is a
  LiveChannelStatusLookup UUID and description is the name (Idle, Running, …). Map
  via reference/enums.md.

Requires an admin session (raises InvalidAPITypeException otherwise). To read a
single channel's status directly, JS also exposes getLiveChannelStatus (Python keeps it
internal).

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