Update an input

POST

/v1/streams/inputs/{inputId}

curl --request POST \
  --url https://api.ligr.live/rest/v1/streams/inputs/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "sourceUrl": "example", "latencyMs": 1 }'

• LIGR REST API

Updates an input. The host, the application name and the stream key never change. To change the latency of a running stream, use set input latency on the stream instead.

Authorizations

• bearer
  streams:write
• api_key
  streams:write

Parameters

Path Parameters

inputId

required

Entity identifier

integer format: int32

>= 1

The input identifier

Request Body^required

Media typeapplication/json

object

name

string

sourceUrl

string

nullable

latencyMs

integer format: int32

Example^generated

{
  "name": "example",
  "sourceUrl": "example",
  "latencyMs": 1
}

Responses

200

Ok

Media typeapplication/json

An input of the organization. A default input is a push endpoint LIGR hosts: send RTMP to rtmpUrl with streamKey, or SRT to srtUrl. A pull input reads sourceUrl.

object

id

required

Entity identifier

integer format: int32

>= 1

name

required

string

type

required

string

Allowed values: default pull

host

required

string

applicationName

required

string

streamKey

required

string

rtmpUrl

required

RTMP ingest URL. Publish with streamKey as the stream key.

string

srtUrl

required

SRT ingest URL, stream id included.

string

sourceUrl

required

For a pull input: the URL LIGR pulls.

string

nullable

latencyMs

required

Receive latency in milliseconds.

number format: double

createdAt

required

string

updatedAt

required

string

Example

{
  "type": "default"
}

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

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