PATCH
/
streaming
/
restreams
/
{restream_id}
Change restream
curl --request PATCH \
  --url https://api.gcore.com/streaming/restreams/{restream_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "restream": {
    "name": "first restream",
    "active": true,
    "uri": "rtmp://a.rtmp.youtube.com/live/k17a-13s8",
    "stream_id": 20,
    "client_user_id": 10
  }
}'
{
  "name": "first restream",
  "active": true,
  "uri": "rtmp://a.rtmp.youtube.com/live/k17a-13s8",
  "stream_id": 20,
  "client_user_id": 10
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
restream_id
integer
required

Restream ID.
IDs of all created restreams can be received via Get All Restreams request

Body

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

Response

Successful

​
name
string

Restream name

​
live
boolean

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

  • true — stream is being published
  • false — stream isn't published
​
active
boolean

Enables/Disables restream. Has two possible values:

  • true — restream is enabled and can be started

  • false — restream is disabled.

Default is true

​
uri
string

A URL to push the stream to

​
stream_id
integer

ID of the stream to restream

​
client_user_id
integer

Custom field where you can specify user ID in your system