Start a stream

POST

/v1/streams/{streamSettingsId}/start

curl --request POST \
  --url https://api.ligr.live/rest/v1/streams/1/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "destinationIds": [ 1 ] }'

• LIGR REST API

Starts the stream. The stream infrastructure comes up and the state moves through CREATING to ONLIVE. Without destinationIds the stream publishes nowhere until an operator starts the destinations from the dashboard, which is how you preview the picture. With destinationIds those destinations publish as soon as the stream is up.

Authorizations

• bearer
  streams:write
• api_key
  streams:write

Parameters

Path Parameters

streamSettingsId

required

Entity identifier

integer format: int32

>= 1

The stream settings identifier

Request Body^required

Media typeapplication/json

object

destinationIds

Destinations to publish to as soon as the stream is up, by stream destination id. Leave it out to start the stream with no destination publishing: the picture runs, and an operator starts the destinations from the dashboard when it is right. An empty array means the same.

Array<number>

Example^generated

{
  "destinationIds": [
    1
  ]
}

Responses

200

Ok

Media typeapplication/json

object

streamSettingsId

required

Entity identifier

integer format: int32

>= 1

state

required

string

matchId

required

Entity identifier

integer format: int32

>= 1

transitioning

required

boolean

Example^generated

{
  "streamSettingsId": 1,
  "state": "example",
  "matchId": 1,
  "transitioning": true
}

400

Request is invalid

Media typeapplication/json

object

message

required

string

details

required

object

key

additional properties

Example^generated

{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Missing or invalid api key

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Api key provides insufficient access for the request

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

404

Stream not found

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

429

Api key has made too many requests

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

500

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

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}