CAcamb
Apis
Streaming

Update Flow

Rename a flow or bring its relay online/offline.

patch/flows/{flow_id}

Request

  • Base URL
    https://client.camb.ai/apis
  • URL
    https://client.camb.ai/apis/flows/{flow_id}
  • Auth
    API key in header x-api-key

Path parameters

flow_idinteger required

Identifier of the flow.

Request body

labelstring nullable

New label (unique within your team).

activeboolean nullable

Set true to bring the flow's relay online, false to take it offline.

Response

The updated flow.

idinteger

Flow identifier.

labelstring
mode'caller' | 'listener'

caller: Camb.ai connects out to your SRT endpoint (primary_url) and re-serves it. listener: Camb.ai hosts an SRT endpoint that your encoder pushes to.

failoverboolean
activeboolean

Whether the flow's relay is currently online.

team_idinteger
keystring

Access key embedded in the flow's URLs.

play_urlstring

SRT URL the flow serves. Use it as source_stream.url or as a target_streams[].url, or play it directly.

passphrasestring nullable

The flow's SRT encryption passphrase, when one is set.

Changes

No recorded changes to this operation across all 1 revision of this API.