v1

latestOpenAPI 3.1.02026-07-2416666272.6 KB

Update live

Updates an existing live stream. All body fields are optional — only the fields you send will be changed. Returns the updated LiveItem.

put/{live_id}

Path parameters

live_idstring required

Request body

titlestring

Updated title of the live stream.

scheduled_atstring date-time

Updated scheduled start time (ISO 8601).

bitratestring[]

Updated video qualities for adaptive playback.

latency_type'low' | 'default' | 'high'

Updated latency profile. low (5-7s) / default (15-20s) / high (60-70s).

active_dvrboolean

Toggles DVR (rewind during the broadcast).

folder_idstring uuid

Folder where the recorded video will be stored after the live ends.

status'online' | 'offline' | 'canceled' | 'finished' | 'finished_imported'

Override the live status. Typically used to cancel a scheduled live with 'canceled'.

Example request

{
  "title": "Updated live title",
  "scheduled_at": "2026-06-15T15:00:00Z",
  "bitrate": [
    "360p",
    "720p"
  ],
  "latency_type": "low",
  "active_dvr": true,
  "status": "canceled"
}

Response

200

idstring

titlestring

stream_key_idstring

stream_keystring

rtmpstring

user_idstring

started_atstring

{"stackTrail":"paths:/{live_id}:put:responses:200:content:application/json:schema:properties:ended_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/{live_id}:put:responses:200:content:application/json:schema:properties:vod_id","oasType":"schema","type":"unknown"}

statusstring

live_playerstring

live_hlsstring

{"stackTrail":"paths:/{live_id}:put:responses:200:content:application/json:schema:properties:bitrate","oasType":"schema","type":"unknown"}

active_dvrboolean

{"stackTrail":"paths:/{live_id}:put:responses:200:content:application/json:schema:properties:folder_id","oasType":"schema","type":"unknown"}

created_atstring

latency_typestring

Example response

{
  "id": "X",
  "title": "X",
  "stream_key_id": "X",
  "stream_key": "X",
  "rtmp": "X",
  "user_id": "X",
  "started_at": "X",
  "status": "X",
  "live_player": "X",
  "live_hls": "X",
  "active_dvr": true,
  "created_at": "X",
  "latency_type": "X"
}