Update an SRT Flow

PATCH

flows

{flow_id}

curl -X PATCH "https://client.camb.ai/apis/flows/42" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "active": false }'

import requests

response = requests.patch(
    "https://client.camb.ai/apis/flows/42",
    headers={"x-api-key": "YOUR_API_KEY"},
    json={"active": False},
)

response.raise_for_status()
print(response.json())

{
  "id": 123,
  "label": "<string>",
  "mode": "caller",
  "failover": true,
  "active": true,
  "team_id": 123,
  "region": "<string>",
  "key": "<string>",
  "play_url": "<string>",
  "push_urls": [
    {
      "role": "primary",
      "url": "<string>"
    }
  ],
  "passphrase": "<string>",
  "egress_primary_url": "<string>",
  "egress_backup_url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Overview

Updates a flow. Only label, active, egress_primary_url and egress_backup_url can be changed. To change a flow’s mode, upstream URLs, failover setup, or region, delete it and create a new one. Setting active controls whether the flow’s SRT endpoint is online. Inactive flows keep their URLs and key, so you can take an endpoint offline between events without reconfiguring your encoders. The egress URLs follow the same rules as on create. Fields you omit keep their value, and null removes a destination. Removing egress_primary_url also requires removing egress_backup_url. Any egress change briefly reconnects both destinations.

Stop pushing to the backup destination

{ "egress_backup_url": null }

curl -X PATCH "https://client.camb.ai/apis/flows/42" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "active": false }'

import requests

response = requests.patch(
    "https://client.camb.ai/apis/flows/42",
    headers={"x-api-key": "YOUR_API_KEY"},
    json={"active": False},
)

response.raise_for_status()
print(response.json())

Errors

404 - No flow with this ID belongs to your team.
422 - Validation error (e.g. a label already used by another of your team’s flows, an invalid egress URL, or a backup egress destination without a primary).

Authorizations

x-api-key

string

header

required

The x-api-key is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.

Path Parameters

flow_id

integer

required

Identifier of the flow.

Body

application/json

Partial update of a flow. Only label, active and the egress URLs can change; to change the upstream URLs, mode, failover or region, delete and recreate the flow.

label

string | null

New label (unique within your team).

active

boolean | null

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

egress_primary_url

string | null

Replace the primary egress destination (same rules as on create). null stops egress; it then requires egress_backup_url to be null too. Omit to keep the current value. A change briefly reconnects both egress destinations.

egress_backup_url

string | null

Replace the backup egress destination, or null to remove it. Omit to keep the current value.

Response

The updated flow.

integer

Flow identifier.

label

string

mode

enum<string>

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.

Available options:

caller,

listener

failover

boolean

active

boolean

Whether the flow's relay is currently online.

team_id

integer

region

string | null

Region hosting the flow's SRT endpoint, as chosen at create. The flow's URLs carry this region's address.

key

string

Access key embedded in the flow's URLs.

play_url

string

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

push_urls

PushUrl · object[]

SRT URLs to push into (listener mode). Empty for caller flows.

Hide child attributes

push_urls.role

enum<string>

Which leg of the flow this URL feeds.

Available options:

primary,

backup

push_urls.url

string

SRT URL to push to.

passphrase

string | null

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

egress_primary_url

string | null

The primary egress destination as you set it, including any query parameters, or null.

egress_backup_url

string | null

The backup egress destination as you set it, or null.

Last modified on October 28, 2026

curl -X PATCH "https://client.camb.ai/apis/flows/42" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "active": false }'

import requests

response = requests.patch(
    "https://client.camb.ai/apis/flows/42",
    headers={"x-api-key": "YOUR_API_KEY"},
    json={"active": False},
)

response.raise_for_status()
print(response.json())

{
  "id": 123,
  "label": "<string>",
  "mode": "caller",
  "failover": true,
  "active": true,
  "team_id": 123,
  "region": "<string>",
  "key": "<string>",
  "play_url": "<string>",
  "push_urls": [
    {
      "role": "primary",
      "url": "<string>"
    }
  ],
  "passphrase": "<string>",
  "egress_primary_url": "<string>",
  "egress_backup_url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Getting Started

Models

Tutorials

SDK Guides

Hosting Platforms

Integrations

API Reference

Other Products

Release Logs

Update an SRT Flow

Overview

Errors

Authorizations

Path Parameters

Body

Response

​Overview

​Errors

​Related endpoints

Authorizations

Path Parameters

Body

Response

Overview

Errors

Related endpoints