Create a live relay

A Relay is ingesting object that contains the information required to access 3rd ingest servers (a.k.a RTMP/broadcast destination). Use the key and url to configure it.

/v1/live-entities/:id/relays

POST https://api.uiza.io/api-live/owner/v1/live-entities/:id/relays

Path Parameters

Name
Type
Description

id

String

The identifier of the live entity you want to create a new relay into it.

Request Body

Name
Type
Description

name

String

The name of your broadcast destination.

url

string

The new RTMP server endpoint to be updated, make sure it included the rtmp:// prefix.

key

string

The key of your new RTMP server that you want the live entity relay to.

{
  "data": {
    "id": "8cf47749-1fa4-40e9-8303-580b34f14683",
    "name": "Replay name3333",
    "url": "rtmp://a.rtmp.youtube.com/live2",
    "key": "0df3-76bz-6t4r-1by5xxxxxx",
    "status": "enable",
    "created_at": "2020-06-24T16:25:58Z",
    "updated_at": "2020-06-24T16:25:58Z"
  }
}

The relay information is included in a live entity.

Sample Request
curl -X POST https://api.uiza.io/api-live/owner/v1/live-entities/22013d8a-d5fa-48f0-9a63-1f471ca9e81d/relays 
    -H 'Accept: */*' 
    -H 'Authorization: <token>' 
    -H 'uiza-app-id: <your_app_id>' 
    -H 'Cache-Control: no-cache' 
    -H 'Connection: keep-alive' 
    -d '{"name": "A Relay Updated", "url": "rtmp://youtu.be/live", "key": "test-key"}'

Last updated