Send a stream command (deprecated)

Deprecated

POST

/v1/streams/{streamSettingsId}/manage

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

• LIGR REST API

Deprecated. Use POST /v1/streams/{streamSettingsId}/start and POST /v1/streams/{streamSettingsId}/stop. This route keeps working until the Sunset date in its response headers, and accepts GoLive and StopStream only.

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

command

required

The lifecycle commands the deprecated manage route still accepts. Use POST .../start and POST .../stop instead.

string

Allowed values: GoLive StopStream

startDestinationsImmediately

Destinations to start at once with GoLive, by stream destination id. Leave it out to start the stream with no destination publishing. Ignored by StopStream.

Array<number>

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"
}