Creates a new SRT source.

curl --request POST \
  --url https://api.up.telestream.com/livesources/v1/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "srt_settings": {
    "minimum_latency": 21,
    "port": 50499,
    "ip": "127.0.0.1",
    "whitelisted_ip_addresses": [
      "127.0.0.1"
    ],
    "force_8bit_video": true,
    "free_run_timecode": true,
    "freeze_on_los": true,
    "srt_passthrough": {
      "enabled": true,
      "port": 50499,
      "latency": 1
    }
  },
  "description": "",
  "engine_version": "<string>",
  "redundancy": false,
  "region": "<string>",
  "tags": [
    "<string>"
  ]
}
'

import requests

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

payload = {
    "name": "<string>",
    "srt_settings": {
        "minimum_latency": 21,
        "port": 50499,
        "ip": "127.0.0.1",
        "whitelisted_ip_addresses": ["127.0.0.1"],
        "force_8bit_video": True,
        "free_run_timecode": True,
        "freeze_on_los": True,
        "srt_passthrough": {
            "enabled": True,
            "port": 50499,
            "latency": 1
        }
    },
    "description": "",
    "engine_version": "<string>",
    "redundancy": False,
    "region": "<string>",
    "tags": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    srt_settings: {
      minimum_latency: 21,
      port: 50499,
      ip: '127.0.0.1',
      whitelisted_ip_addresses: ['127.0.0.1'],
      force_8bit_video: true,
      free_run_timecode: true,
      freeze_on_los: true,
      srt_passthrough: {enabled: true, port: 50499, latency: 1}
    },
    description: '',
    engine_version: '<string>',
    redundancy: false,
    region: '<string>',
    tags: ['<string>']
  })
};

fetch('https://api.up.telestream.com/livesources/v1/sources', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'srt_settings' => [
        'minimum_latency' => 21,
        'port' => 50499,
        'ip' => '127.0.0.1',
        'whitelisted_ip_addresses' => [
                '127.0.0.1'
        ],
        'force_8bit_video' => true,
        'free_run_timecode' => true,
        'freeze_on_los' => true,
        'srt_passthrough' => [
                'enabled' => true,
                'port' => 50499,
                'latency' => 1
        ]
    ],
    'description' => '',
    'engine_version' => '<string>',
    'redundancy' => false,
    'region' => '<string>',
    '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"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"srt_settings\": {\n    \"minimum_latency\": 21,\n    \"port\": 50499,\n    \"ip\": \"127.0.0.1\",\n    \"whitelisted_ip_addresses\": [\n      \"127.0.0.1\"\n    ],\n    \"force_8bit_video\": true,\n    \"free_run_timecode\": true,\n    \"freeze_on_los\": true,\n    \"srt_passthrough\": {\n      \"enabled\": true,\n      \"port\": 50499,\n      \"latency\": 1\n    }\n  },\n  \"description\": \"\",\n  \"engine_version\": \"<string>\",\n  \"redundancy\": false,\n  \"region\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.up.telestream.com/livesources/v1/sources")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"srt_settings\": {\n    \"minimum_latency\": 21,\n    \"port\": 50499,\n    \"ip\": \"127.0.0.1\",\n    \"whitelisted_ip_addresses\": [\n      \"127.0.0.1\"\n    ],\n    \"force_8bit_video\": true,\n    \"free_run_timecode\": true,\n    \"freeze_on_los\": true,\n    \"srt_passthrough\": {\n      \"enabled\": true,\n      \"port\": 50499,\n      \"latency\": 1\n    }\n  },\n  \"description\": \"\",\n  \"engine_version\": \"<string>\",\n  \"redundancy\": false,\n  \"region\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"srt_settings\": {\n    \"minimum_latency\": 21,\n    \"port\": 50499,\n    \"ip\": \"127.0.0.1\",\n    \"whitelisted_ip_addresses\": [\n      \"127.0.0.1\"\n    ],\n    \"force_8bit_video\": true,\n    \"free_run_timecode\": true,\n    \"freeze_on_los\": true,\n    \"srt_passthrough\": {\n      \"enabled\": true,\n      \"port\": 50499,\n      \"latency\": 1\n    }\n  },\n  \"description\": \"\",\n  \"engine_version\": \"<string>\",\n  \"redundancy\": false,\n  \"region\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "SRT",
  "name": "<string>",
  "description": "<string>",
  "redundancy": true,
  "srt_settings": {
    "minimum_latency": 21,
    "port": 50499,
    "ip": "127.0.0.1",
    "whitelisted_ip_addresses": [
      "127.0.0.1"
    ],
    "redundant_source": {
      "enabled": true,
      "port": 50499,
      "ip": "127.0.0.1"
    },
    "aes_encryption": {
      "enabled": true,
      "passphrase": "<string>",
      "backup_passphrase": "<string>"
    },
    "force_8bit_video": true,
    "free_run_timecode": true,
    "freeze_on_los": true,
    "srt_passthrough": {
      "enabled": true,
      "port": 50499,
      "latency": 1
    }
  },
  "activated_at": "2023-11-07T05:31:56Z",
  "engine_version": "<string>",
  "errors": [
    "<string>"
  ],
  "passthrough_url": "<string>",
  "primary_ingress_url": "<string>",
  "region": "<string>",
  "secondary_ingress_url": "<string>",
  "stream_metadata": "<string>",
  "tags": [
    "<string>"
  ],
  "transport_statistics_primary": "<string>",
  "transport_statistics_secondary": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error_message": "<string>"
}

{
  "errors": {}
}

{
  "error_message": "<string>"
}

POST

sources

Creates a new SRT source.

curl --request POST \
  --url https://api.up.telestream.com/livesources/v1/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "srt_settings": {
    "minimum_latency": 21,
    "port": 50499,
    "ip": "127.0.0.1",
    "whitelisted_ip_addresses": [
      "127.0.0.1"
    ],
    "force_8bit_video": true,
    "free_run_timecode": true,
    "freeze_on_los": true,
    "srt_passthrough": {
      "enabled": true,
      "port": 50499,
      "latency": 1
    }
  },
  "description": "",
  "engine_version": "<string>",
  "redundancy": false,
  "region": "<string>",
  "tags": [
    "<string>"
  ]
}
'

import requests

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

payload = {
    "name": "<string>",
    "srt_settings": {
        "minimum_latency": 21,
        "port": 50499,
        "ip": "127.0.0.1",
        "whitelisted_ip_addresses": ["127.0.0.1"],
        "force_8bit_video": True,
        "free_run_timecode": True,
        "freeze_on_los": True,
        "srt_passthrough": {
            "enabled": True,
            "port": 50499,
            "latency": 1
        }
    },
    "description": "",
    "engine_version": "<string>",
    "redundancy": False,
    "region": "<string>",
    "tags": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    srt_settings: {
      minimum_latency: 21,
      port: 50499,
      ip: '127.0.0.1',
      whitelisted_ip_addresses: ['127.0.0.1'],
      force_8bit_video: true,
      free_run_timecode: true,
      freeze_on_los: true,
      srt_passthrough: {enabled: true, port: 50499, latency: 1}
    },
    description: '',
    engine_version: '<string>',
    redundancy: false,
    region: '<string>',
    tags: ['<string>']
  })
};

fetch('https://api.up.telestream.com/livesources/v1/sources', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'srt_settings' => [
        'minimum_latency' => 21,
        'port' => 50499,
        'ip' => '127.0.0.1',
        'whitelisted_ip_addresses' => [
                '127.0.0.1'
        ],
        'force_8bit_video' => true,
        'free_run_timecode' => true,
        'freeze_on_los' => true,
        'srt_passthrough' => [
                'enabled' => true,
                'port' => 50499,
                'latency' => 1
        ]
    ],
    'description' => '',
    'engine_version' => '<string>',
    'redundancy' => false,
    'region' => '<string>',
    '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"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"srt_settings\": {\n    \"minimum_latency\": 21,\n    \"port\": 50499,\n    \"ip\": \"127.0.0.1\",\n    \"whitelisted_ip_addresses\": [\n      \"127.0.0.1\"\n    ],\n    \"force_8bit_video\": true,\n    \"free_run_timecode\": true,\n    \"freeze_on_los\": true,\n    \"srt_passthrough\": {\n      \"enabled\": true,\n      \"port\": 50499,\n      \"latency\": 1\n    }\n  },\n  \"description\": \"\",\n  \"engine_version\": \"<string>\",\n  \"redundancy\": false,\n  \"region\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.up.telestream.com/livesources/v1/sources")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"srt_settings\": {\n    \"minimum_latency\": 21,\n    \"port\": 50499,\n    \"ip\": \"127.0.0.1\",\n    \"whitelisted_ip_addresses\": [\n      \"127.0.0.1\"\n    ],\n    \"force_8bit_video\": true,\n    \"free_run_timecode\": true,\n    \"freeze_on_los\": true,\n    \"srt_passthrough\": {\n      \"enabled\": true,\n      \"port\": 50499,\n      \"latency\": 1\n    }\n  },\n  \"description\": \"\",\n  \"engine_version\": \"<string>\",\n  \"redundancy\": false,\n  \"region\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"srt_settings\": {\n    \"minimum_latency\": 21,\n    \"port\": 50499,\n    \"ip\": \"127.0.0.1\",\n    \"whitelisted_ip_addresses\": [\n      \"127.0.0.1\"\n    ],\n    \"force_8bit_video\": true,\n    \"free_run_timecode\": true,\n    \"freeze_on_los\": true,\n    \"srt_passthrough\": {\n      \"enabled\": true,\n      \"port\": 50499,\n      \"latency\": 1\n    }\n  },\n  \"description\": \"\",\n  \"engine_version\": \"<string>\",\n  \"redundancy\": false,\n  \"region\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "SRT",
  "name": "<string>",
  "description": "<string>",
  "redundancy": true,
  "srt_settings": {
    "minimum_latency": 21,
    "port": 50499,
    "ip": "127.0.0.1",
    "whitelisted_ip_addresses": [
      "127.0.0.1"
    ],
    "redundant_source": {
      "enabled": true,
      "port": 50499,
      "ip": "127.0.0.1"
    },
    "aes_encryption": {
      "enabled": true,
      "passphrase": "<string>",
      "backup_passphrase": "<string>"
    },
    "force_8bit_video": true,
    "free_run_timecode": true,
    "freeze_on_los": true,
    "srt_passthrough": {
      "enabled": true,
      "port": 50499,
      "latency": 1
    }
  },
  "activated_at": "2023-11-07T05:31:56Z",
  "engine_version": "<string>",
  "errors": [
    "<string>"
  ],
  "passthrough_url": "<string>",
  "primary_ingress_url": "<string>",
  "region": "<string>",
  "secondary_ingress_url": "<string>",
  "stream_metadata": "<string>",
  "tags": [
    "<string>"
  ],
  "transport_statistics_primary": "<string>",
  "transport_statistics_secondary": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error_message": "<string>"
}

{
  "errors": {}
}

{
  "error_message": "<string>"
}

Authorizations

Authorization

string

header

required

OAuth2 bearer token in the Authorization header

Body

application/json

name

string

required

srt_settings

object

required

SRT receiver configuration. Validated server-side against the JSON schema bundled with the LiveSources service (schemas/srt_settings.json). Field semantics:

mode — listener (UP listens for an incoming SRT connection) or caller (UP dials out to a remote SRT server).
In listener mode, whitelisted_ip_addresses is required and ip / port (top-level and inside redundant_source) are ignored.
In caller mode, top-level ip and port are required.
If redundant_source.enabled is true and mode is caller, redundant_source.ip and redundant_source.port are required.
If aes_encryption.enabled is true, key_length and passphrase are required. When the source is also redundant, backup_key_length and backup_passphrase are required as well.

The REST gateway exposes these settings as a structured object using the snake_case names below; the upstream GraphQL service stores the same data as a JSON-serialised string with camelCase keys (e.g. whitelistedIpAddresses). The gateway translates names in both directions.

Show child attributes

Example:

{
  "mode": "listener",
  "minimum_latency": 120,
  "whitelisted_ip_addresses": ["203.0.113.10", "203.0.113.11"],
  "redundant_source": { "enabled": false },
  "aes_encryption": {
    "enabled": true,
    "key_length": "128",
    "passphrase": "correct horse battery staple"
  },
  "force_8bit_video": false,
  "free_run_timecode": false,
  "freeze_on_los": true,
  "srt_passthrough": { "enabled": false }
}

description

string

default:""

engine_version

string | null

redundancy

boolean

default:false

region

string | null

Response

Source created

SRT-specific source representation. Extends Source.

string<uuid>

required

read-only

This is the GUID for the Source.

Example:

"e3c908ad-dc8f-4edb-88f7-c84dec0aef99"

kind

enum<string>

required

read-only

Available options:

SRT

Example:

"SRT"

name

string

required

Source name

Example:

"CNN East Feed"

description

string

required

Describes the Source purpose

Example:

"Primary east-coast feed for breaking news."

status

enum<string>

required

read-only

Available options:

INACTIVE,

PENDING,

ACTIVE,

STOPPING,

ERROR

Example:

"ACTIVE"

active_receiver

enum<string>

required

read-only

Available options:

PRIMARY,

SECONDARY,

UNKNOWN

primary_connection_state

enum<string>

required

read-only

Available options:

CONNECTED,

DISCONNECTED,

WAITING

secondary_connection_state

enum<string>

required

read-only

Available options:

CONNECTED,

DISCONNECTED,

WAITING

redundancy

boolean

required

Whether two SRT receivers are deployed for redundancy.

srt_settings

object

required

SRT receiver configuration. Validated server-side against the JSON schema bundled with the LiveSources service (schemas/srt_settings.json). Field semantics:

mode — listener (UP listens for an incoming SRT connection) or caller (UP dials out to a remote SRT server).
In listener mode, whitelisted_ip_addresses is required and ip / port (top-level and inside redundant_source) are ignored.
In caller mode, top-level ip and port are required.
If redundant_source.enabled is true and mode is caller, redundant_source.ip and redundant_source.port are required.
If aes_encryption.enabled is true, key_length and passphrase are required. When the source is also redundant, backup_key_length and backup_passphrase are required as well.

Show child attributes

Example:

{
  "mode": "listener",
  "minimum_latency": 120,
  "whitelisted_ip_addresses": ["203.0.113.10", "203.0.113.11"],
  "redundant_source": { "enabled": false },
  "aes_encryption": {
    "enabled": true,
    "key_length": "128",
    "passphrase": "correct horse battery staple"
  },
  "force_8bit_video": false,
  "free_run_timecode": false,
  "freeze_on_los": true,
  "srt_passthrough": { "enabled": false }
}

activated_at

string<date-time> | null

read-only

Timestamp when the Source was last activated, in UTC iso8601 format.

Example:

"2025-04-21T15:53:12.388317Z"

engine_version

string | null

Engine version that hosts the source.

errors

string[] | null

read-only

passthrough_url

string | null

read-only

Optional SRT passthrough URL when the source has passthrough enabled.

primary_ingress_url

string | null

read-only

Ingress URL the customer's encoder pushes the primary stream to (caller mode), or that LiveCapture listens on (listener mode).

region

string | null

Cloud region in which the source is hosted.

secondary_ingress_url

string | null

read-only

Ingress URL for the redundant receiver, when redundancy is enabled.

stream_metadata

string | null

read-only

Engine-reported metadata of the active stream as a JSON string.

Live Sources

source

access

Creates a new SRT source.

Authorizations

Body

Response