API

Update stream

put
https://{hostname}/api/v1/streams/

Update an existing stream's configuration. This is a full update; omitted optional fields will be reset to their default values, not preserved. See each field description for details.

Path Params
string
required

Stream ID.

Body Params
allowed_ips
array of objects
required
length ≤ 270

List of allowed IP addresses for ingest (max 270). Each entry is a single IP or CIDR range.
An empty array means access is unrestricted (all IPs allowed). If omitted, resets to [] (unrestricted).

allowed_ips*
archiving
object

Updated archiving configuration. If omitted, resets to null.

string | null

Stream description, used as the display name. If omitted or set to null, resets to null.
Duplicate names are permitted;

string | null

Group identifier. If omitted, the value is unchanged.

hls_to_llhls
object

Low-Latency HLS configuration. If omitted, resets to null (disabled).

boolean | null

Whether to enable ingest authentication. If omitted, the value is unchanged.

string
enum

Ingest authentication mode. If omitted, the value is unchanged.

Allowed:
ingest_header
object

Ingest header. If omitted (and ingest_authentication_mode is also omitted), the value is unchanged.

playback
object

Updated playback configuration. If omitted, resets to null.

int32 | null

Playlist duration in minutes (range: -1 to 720). Use -1 to follow the encoder's playlist duration
(capped at 720 minutes). Omitted or null resets to -1 (follow). This field supersedes the
deprecated dvr_window_in_min; do not send both.

Responses
202

Stream updated successfully.

Updated 2 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago