live_channel_refresh

Resync the platform's live-channel state with the underlying infrastructure.

Trigger a system-wide refresh so channel status reflects the live infrastructure. Useful before reading status when a channel may have changed out-of-band.

Safety class: B · API type: admin · Min version: —

📘

Confinement

Class B: no folder effect, but it mutates account-wide live-channel state (status sync). Non-prod unless proven; never on prod by default.

Signatures

def live_channel_refresh(sdk):
    """Refresh all live channels' status from infrastructure. Returns None; re-read
    via get_live_channels to observe the refreshed state."""
    return sdk.live_channel_refresh()

export async function liveChannelRefresh(sdk) {
    // Re-read via getLiveChannels to observe the refreshed state.
    return await sdk.liveChannelRefresh();
}

Parameters

Returns

None — no payload; raises on HTTP error. Re-read get_live_channels afterwards to see refreshed status.

Errors

• 401 unauthenticated
• InvalidAPITypeException if session is not admin

Notes

Real-world usage

• Maps to POST /api/liveChannel/refresh, used to refresh the channels list before re-rendering status badges.
• It is account-wide (no channel id), so treat it as Class B: harmless in steady state but it touches shared state — keep it off prod by default.

Requires an admin session (raises InvalidAPITypeException otherwise).

Real-world usage

• Maps to POST /api/liveChannel/refresh; refreshes the channel list.
• Account-wide (no channel id), so treat it as Class B: harmless in steady state but it touches shared state — keep it off prod by default.

Requires an admin session (raises InvalidAPITypeException otherwise).

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