Skip to content
Developers

Create a destination

POST/v1/streams/destinations

POST
/v1/streams/destinations
curl --request POST \
  --url https://api.ligr.live/rest/v1/streams/destinations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "YouTube main", "type": "youtube", "url": "rtmp://a.rtmp.youtube.com/live2", "key": "abcd-efgh-ijkl-mnop" }'

Creates a destination. A push destination needs url and key. A pull destination needs neither: LIGR serves it, and the answer carries pullUrl.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
type
required
string
Allowed values: youtube facebook twitter linkedin tiktok twitch custom perform genius img igame fifa+ infront
transportDirection

push sends to url. pull lets a player pull from LIGR. Default push.

string
Allowed values: push pull
transportProtocol

Inferred from the url when left out: srt:// is SRT, anything else RTMP.

string
Allowed values: rtmp srt
feedType

Default program.

string
Allowed values: program clean
url

Server URL. Required for a push destination.

string
key

Stream key. Required for a push destination.

string
Example
{
  "name": "YouTube main",
  "type": "youtube",
  "url": "rtmp://a.rtmp.youtube.com/live2",
  "key": "abcd-efgh-ijkl-mnop"
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json

A saved destination of the organization. url and key are the server URL and the stream key for a push destination. A pull destination has no url and key; LIGR serves it at pullUrl.

object
id
required

Entity identifier

integer format: int32
>= 1
name
required
string
type
required
string
Allowed values: youtube facebook twitter linkedin tiktok twitch custom perform genius img igame fifa+ infront
transportDirection
required
string
Allowed values: push pull
transportProtocol
required
string
Allowed values: rtmp srt
feedType
required

program carries the graphics. clean is the picture without them.

string
Allowed values: program clean
url
required
string
nullable
key
required
string
nullable
pullUrl
required

For a pull destination: the URL a player or a relay pulls from.

string
nullable
singleUse
required

True for a destination created for one match by createAndLinkOneOffDestination.

boolean
createdAt
required
string
updatedAt
required
string
Example
{
  "type": "youtube",
  "transportDirection": "push",
  "transportProtocol": "rtmp",
  "feedType": "program"
}

400

Section titled “400”

Request is invalid

Media typeapplication/json
object
message
required
string
details
required
object
key
additional properties
Examplegenerated
{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Missing or invalid api key

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

403

Section titled “403”

Api key provides insufficient access for the request

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

404

Section titled “404”

Destination not found

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

429

Section titled “429”

Api key has made too many requests

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

500

Section titled “500”

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}