API

Create stream

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

Create a new stream with the specified configuration. Any optional field that is omitted will use its default value as documented on each field.

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). This is the default.

allowed_ips*
archiving
object

Archiving configuration.

string | null

Optional backup ingest location, previously known as backup encoder zone. Defaults to the primary ingest_location.

string
required
string
required
string | null

Stream description, used as the display name. Optional (defaults to null).
Mutable via the update endpoint. Duplicate names are permitted;

string
enum
required

Stream format (e.g. HLS).

Allowed:
string
required
hls_to_llhls
object

Optional Low-Latency HLS configuration for the stream. Defaults to null (disabled).

boolean | null

Whether to enable ingest authentication. Defaults to false.

string
enum

Ingest authentication mode. Defaults to null.

Allowed:
ingest_header
object

Ingest header configuration. Defaults to null.

string
required

Primary ingest location, previously known as encoder zone.

string
required

ID of the origin server to use.

playback
object

Optional playback configuration. Defaults 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 defaults to -1 (follow). This field supersedes the
deprecated dvr_window_in_min; do not send both.

Responses

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