Update an SRT source

curl --request PATCH \
  --url https://api.up.telestream.com/livesources/v1/sources/{source_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "engine_version": "<string>",
  "expected_properties": {},
  "name": "<string>",
  "recovery_location": "<string>",
  "recovery_max_size": 2,
  "region": "<string>",
  "srt_settings": {},
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://api.up.telestream.com/livesources/v1/sources/{source_id}"

payload = {
    "description": "<string>",
    "engine_version": "<string>",
    "expected_properties": {},
    "name": "<string>",
    "recovery_location": "<string>",
    "recovery_max_size": 2,
    "region": "<string>",
    "srt_settings": {},
    "tags": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    engine_version: '<string>',
    expected_properties: {},
    name: '<string>',
    recovery_location: '<string>',
    recovery_max_size: 2,
    region: '<string>',
    srt_settings: {},
    tags: ['<string>']
  })
};

fetch('https://api.up.telestream.com/livesources/v1/sources/{source_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.up.telestream.com/livesources/v1/sources/{source_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'engine_version' => '<string>',
    'expected_properties' => [
        
    ],
    'name' => '<string>',
    'recovery_location' => '<string>',
    'recovery_max_size' => 2,
    'region' => '<string>',
    'srt_settings' => [
        
    ],
    'tags' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.up.telestream.com/livesources/v1/sources/{source_id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"engine_version\": \"<string>\",\n  \"expected_properties\": {},\n  \"name\": \"<string>\",\n  \"recovery_location\": \"<string>\",\n  \"recovery_max_size\": 2,\n  \"region\": \"<string>\",\n  \"srt_settings\": {},\n  \"tags\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.up.telestream.com/livesources/v1/sources/{source_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"engine_version\": \"<string>\",\n  \"expected_properties\": {},\n  \"name\": \"<string>\",\n  \"recovery_location\": \"<string>\",\n  \"recovery_max_size\": 2,\n  \"region\": \"<string>\",\n  \"srt_settings\": {},\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.up.telestream.com/livesources/v1/sources/{source_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"engine_version\": \"<string>\",\n  \"expected_properties\": {},\n  \"name\": \"<string>\",\n  \"recovery_location\": \"<string>\",\n  \"recovery_max_size\": 2,\n  \"region\": \"<string>\",\n  \"srt_settings\": {},\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "active_receiver": "primary",
  "description": "<string>",
  "engine_version": "<string>",
  "expected_properties": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "srt",
  "name": "<string>",
  "primary_connection_state": "waiting",
  "redundancy": true,
  "secondary_connection_state": "waiting",
  "srt_settings": {},
  "status": "inactive",
  "activated_at": "2023-11-07T05:31:56Z",
  "passthrough_url": "<string>",
  "primary_ingress_url": "<string>",
  "recovery_location": "<string>",
  "recovery_max_size": 123,
  "region": "<string>",
  "secondary_ingress_url": "<string>",
  "stream_metadata": {},
  "tags": [
    "<string>"
  ],
  "transport_statistics_passthrough": [
    {}
  ],
  "transport_statistics_primary": {},
  "transport_statistics_secondary": {}
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

PATCH

sources

{source_id}

Update an SRT source

curl --request PATCH \
  --url https://api.up.telestream.com/livesources/v1/sources/{source_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "engine_version": "<string>",
  "expected_properties": {},
  "name": "<string>",
  "recovery_location": "<string>",
  "recovery_max_size": 2,
  "region": "<string>",
  "srt_settings": {},
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://api.up.telestream.com/livesources/v1/sources/{source_id}"

payload = {
    "description": "<string>",
    "engine_version": "<string>",
    "expected_properties": {},
    "name": "<string>",
    "recovery_location": "<string>",
    "recovery_max_size": 2,
    "region": "<string>",
    "srt_settings": {},
    "tags": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    engine_version: '<string>',
    expected_properties: {},
    name: '<string>',
    recovery_location: '<string>',
    recovery_max_size: 2,
    region: '<string>',
    srt_settings: {},
    tags: ['<string>']
  })
};

fetch('https://api.up.telestream.com/livesources/v1/sources/{source_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.up.telestream.com/livesources/v1/sources/{source_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'engine_version' => '<string>',
    'expected_properties' => [
        
    ],
    'name' => '<string>',
    'recovery_location' => '<string>',
    'recovery_max_size' => 2,
    'region' => '<string>',
    'srt_settings' => [
        
    ],
    'tags' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.up.telestream.com/livesources/v1/sources/{source_id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"engine_version\": \"<string>\",\n  \"expected_properties\": {},\n  \"name\": \"<string>\",\n  \"recovery_location\": \"<string>\",\n  \"recovery_max_size\": 2,\n  \"region\": \"<string>\",\n  \"srt_settings\": {},\n  \"tags\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.up.telestream.com/livesources/v1/sources/{source_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"engine_version\": \"<string>\",\n  \"expected_properties\": {},\n  \"name\": \"<string>\",\n  \"recovery_location\": \"<string>\",\n  \"recovery_max_size\": 2,\n  \"region\": \"<string>\",\n  \"srt_settings\": {},\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.up.telestream.com/livesources/v1/sources/{source_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"engine_version\": \"<string>\",\n  \"expected_properties\": {},\n  \"name\": \"<string>\",\n  \"recovery_location\": \"<string>\",\n  \"recovery_max_size\": 2,\n  \"region\": \"<string>\",\n  \"srt_settings\": {},\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "active_receiver": "primary",
  "description": "<string>",
  "engine_version": "<string>",
  "expected_properties": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "srt",
  "name": "<string>",
  "primary_connection_state": "waiting",
  "redundancy": true,
  "secondary_connection_state": "waiting",
  "srt_settings": {},
  "status": "inactive",
  "activated_at": "2023-11-07T05:31:56Z",
  "passthrough_url": "<string>",
  "primary_ingress_url": "<string>",
  "recovery_location": "<string>",
  "recovery_max_size": 123,
  "region": "<string>",
  "secondary_ingress_url": "<string>",
  "stream_metadata": {},
  "tags": [
    "<string>"
  ],
  "transport_statistics_passthrough": [
    {}
  ],
  "transport_statistics_primary": {},
  "transport_statistics_secondary": {}
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "trace_id": "<string>"
}

Authorizations

Authorization

string

header

required

A platform API key, presented as Authorization: Bearer <API_KEY>. Each operation says which permission the key needs.

Path Parameters

source_id

string<uuid>

required

The source's id.

Body

application/json

Only the fields present are changed. A nullable field sent as null is cleared; omitting it leaves it unchanged.

description

string

engine_version

string

The engine version to pin, as major.minor.patch; empty keeps the source on the current engine. Pinning is not honoured: the value is kept, and the source follows the current engine.

Maximum string length: 32

expected_properties

object

What the stream is expected to look like. It has to follow the expected properties schema of the source's engine version.

name

string

Identifies the source.

Required string length: 1 - 512

recovery_location

string | null

The store to buffer stream data for recovery in, as a tmi:// URL.

recovery_max_size

integer | null

The recovery buffer's size limit in GB, per session.

Required range: x >= 1

region

string | null

Maximum string length: 30

srt_settings

object

How the source should receive its stream. It has to follow the SRT settings schema of the source's engine version; a document that does not is refused.

Response

The updated source.

A source's configuration, lifecycle state and what is currently arriving on it. Every source of this version is fed over SRT.

active_receiver

enum<string>

required

Which connection the stream is currently taken from.

Available options:

primary,

secondary,

unknown

description

string

required

engine_version

string

required

The engine version the source pins, as major.minor.patch; empty when it follows the current engine.

expected_properties

object

required

What the stream is expected to look like. Its shape is the expected properties schema of the source's engine version.

string<uuid>

required

kind

enum<string>

required

The protocol a source is fed over.

Available options:

srt

name

string

required

primary_connection_state

enum<string>

required

waiting has not been connected to yet; connected is receiving; disconnected was connected and is no longer.

Available options:

waiting,

connected,

disconnected

redundancy

boolean

required

read-only

Whether the source is received over two connections. Read-only; it follows the SRT settings, which are where the second connection is configured.

secondary_connection_state

enum<string>

required

waiting has not been connected to yet; connected is receiving; disconnected was connected and is no longer.

Available options:

waiting,

connected,

disconnected

srt_settings

object

required

How the source receives its stream. Its shape is the SRT settings schema of the source's engine version.

status

enum<string>

required

inactive accepts no stream; pending is being provisioned; active is ready to receive; stopping is still releasing its resources; error cannot be used until it is deactivated.

Available options:

inactive,

pending,

active,

stopping,

error

activated_at

string<date-time>

passthrough_url

string

Where the stream can be pulled from; present only while an active source offers passthrough.

primary_ingress_url

string

Where the stream is pushed to. Absent until the source is active, and for a source that connects out rather than listening.

recovery_location

string

The store holding buffered stream data for recovery, as a tmi:// URL.

recovery_max_size

integer

The recovery buffer's size limit in GB, per session.

region

string

Where the stream receiver is placed.

secondary_ingress_url

string

The second connection's ingress URL; present only for a redundantly received active source.

stream_metadata

object

What was detected in the incoming stream; absent until a stream arrives. Its shape is the metadata schema of the source's engine version.