Skip to main content
PATCH
/
streaming
/
restreams
/
{restream_id}
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
restream = client.streaming.restreams.update(
    restream_id=0,
)
print(restream.client_user_id)
{
  "name": "first restream",
  "active": true,
  "uri": "rtmp://a.rtmp.youtube.com/live/k17a-13s8",
  "stream_id": 20,
  "client_user_id": 10
}

Documentation Index

Fetch the complete documentation index at: https://gcore.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

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. Supported protocols: rtmp, rtmps, srt. For SRT target URLs, only mode=caller is supported.

Example:

"srt://example.com:1234?mode=caller"

​
stream_id
integer

ID of the stream to restream

​
client_user_id
integer

Custom field where you can specify user ID in your system