Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Restreams

Change restream

Updates restream settings, such as the target URI or active status

patch/streaming/restreams/{restream_id}

Path parameters

restream_idinteger required

Restream ID

Request body

Example request

{
  "restream": {
    "name": "first restream",
    "active": true,
    "uri": "rtmp://a.rtmp.youtube.com/live/k17a-13s8",
    "stream_id": 20,
    "client_user_id": 10
  }
}

Response

Successful

namestring

Restream name

liveboolean

Indicates that the stream is being published. Has two possible values:

  • true — stream is being published
  • false — stream isn't published
activeboolean

Enables/Disables restream. Has two possible values:

  • true — restream is enabled and can be started
  • false — restream is disabled.

Default is true

uristring

A URL to push the stream to. Supported protocols: rtmp, rtmps, srt. For SRT target URLs, only mode=caller is supported.

stream_idinteger

ID of the stream to restream

client_user_idinteger

Custom field where you can specify user ID in your system

Example response

{
  "name": "first restream",
  "active": true,
  "uri": "rtmp://a.rtmp.youtube.com/live/k17a-13s8",
  "stream_id": 20,
  "client_user_id": 10
}