get_live_channel

Retrieve one live channel by id (full config, status, schedule, outputs).

Retrieve a single live channel by id. The current lifecycle state is
channel["status"]["description"] (a status name like "Running").

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

📘

Confinement

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

Signatures

def get_live_channel(sdk, live_channel_id):
    """Return the live channel dict for live_channel_id, or None if it does not
    resolve. Status name lives at channel['status']['description']."""
    return sdk.get_live_channel(live_channel_id)

export async function getLiveChannel(sdk, liveChannelId) {
    return await sdk.getLiveChannel(liveChannelId);
}

Parameters

Returns

dict | None - channel object: id, name, status{id,description}, statusMessage, type, outputs, associatedInputs, scheduleEvents, securityGroups; None if not found. See return-shapes.md.

Errors

• 401 unauthenticated
• 404 not found -> returns None
• InvalidAPITypeException if session is not admin

Notes

Real-world usage

• GET /api/liveChannel/{id} returns the full channel detail. Read
  status ({id, description}), statusMessage, type (a lookup), outputs,
  associatedInputs, and scheduleEvents.
• Deriving status without a status verb. The Python SDK keeps
  get_live_channel_status internal; read channel["status"]["description"] off this
  object instead. The JS SDK exposes getLiveChannelStatus publicly.

Requires an admin session (raises InvalidAPITypeException otherwise).

Real-world usage

• Maps to GET /api/liveChannel/{id} for full channel detail. Reads status
  ({id, description}), statusMessage, type, outputs, associatedInputs,
  scheduleEvents.
• For just the status string, JS can call getLiveChannelStatus(liveChannelId) directly -
  it returns channel.status.description. (Python exposes this only internally; the public
  Python path reads channel["status"]["description"].)

Requires an admin session (raises InvalidAPITypeException otherwise).

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