Stop stream destinations

POST

/v1/streams/{streamSettingsId}/destinations/stop

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

• LIGR REST API

Stops publishing to the given destinations. The stream keeps running, so you can start them again. A stream that is not running answers 400.

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

required

Stream destination ids. A destination must be linked to the stream.

Array<number>

>= 1 items

Example^generated

{
  "destinationIds": [
    1
  ]
}

Responses

200

Ok

Media typeapplication/json

object

streamSettingsId

required

Entity identifier

integer format: int32

>= 1

matchId

required

Entity identifier

integer format: int32

>= 1

destinations

required

Array<object>

What the stream reports for one destination right after a start or a stop.

object

id

required

Entity identifier

integer format: int32

>= 1

status

required

connected, connecting or retrying.

string

bitrateKb

required

Outgoing bitrate in kb/s. Present when the status is connected.

number format: double

nullable

nextRetryDate

required

Time of the next connection attempt, in ISO 8601. Present when the status is retrying.

string

nullable

activeClients

required

Number of connected clients. Pull destinations only.

number format: double

nullable

Example^generated

{
  "streamSettingsId": 1,
  "matchId": 1,
  "destinations": [
    {
      "id": 1,
      "status": "example",
      "bitrateKb": 1,
      "nextRetryDate": "example",
      "activeClients": 1
    }
  ]
}

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