Update a channel - Telestream UP Documentation

Update a channel

curl --request PATCH \
  --url https://api.up.telestream.com/capture/v1/{space_id}/channels/{channel_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "auto_shutdown": {
    "enabled": true,
    "no_recording_timeout": 123,
    "no_stream_timeout": 123
  },
  "description": "<string>",
  "name": "<string>",
  "recording_trigger": {
    "enabled": true
  },
  "region": "<string>",
  "settings": {},
  "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://api.up.telestream.com/capture/v1/{space_id}/channels/{channel_id}"

payload = {
    "auto_shutdown": {
        "enabled": True,
        "no_recording_timeout": 123,
        "no_stream_timeout": 123
    },
    "description": "<string>",
    "name": "<string>",
    "recording_trigger": { "enabled": True },
    "region": "<string>",
    "settings": {},
    "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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({
    auto_shutdown: {enabled: true, no_recording_timeout: 123, no_stream_timeout: 123},
    description: '<string>',
    name: '<string>',
    recording_trigger: {enabled: true},
    region: '<string>',
    settings: {},
    source_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    tags: ['<string>']
  })
};

fetch('https://api.up.telestream.com/capture/v1/{space_id}/channels/{channel_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/capture/v1/{space_id}/channels/{channel_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([
    'auto_shutdown' => [
        'enabled' => true,
        'no_recording_timeout' => 123,
        'no_stream_timeout' => 123
    ],
    'description' => '<string>',
    'name' => '<string>',
    'recording_trigger' => [
        'enabled' => true
    ],
    'region' => '<string>',
    'settings' => [
        
    ],
    'source_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    '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/capture/v1/{space_id}/channels/{channel_id}"

	payload := strings.NewReader("{\n  \"auto_shutdown\": {\n    \"enabled\": true,\n    \"no_recording_timeout\": 123,\n    \"no_stream_timeout\": 123\n  },\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"recording_trigger\": {\n    \"enabled\": true\n  },\n  \"region\": \"<string>\",\n  \"settings\": {},\n  \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\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/capture/v1/{space_id}/channels/{channel_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"auto_shutdown\": {\n    \"enabled\": true,\n    \"no_recording_timeout\": 123,\n    \"no_stream_timeout\": 123\n  },\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"recording_trigger\": {\n    \"enabled\": true\n  },\n  \"region\": \"<string>\",\n  \"settings\": {},\n  \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.up.telestream.com/capture/v1/{space_id}/channels/{channel_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  \"auto_shutdown\": {\n    \"enabled\": true,\n    \"no_recording_timeout\": 123,\n    \"no_stream_timeout\": 123\n  },\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"recording_trigger\": {\n    \"enabled\": true\n  },\n  \"region\": \"<string>\",\n  \"settings\": {},\n  \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

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

{
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "pinned": true,
  "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "draft",
  "activated_at": "2023-11-07T05:31:56Z",
  "auto_shutdown": {
    "enabled": true,
    "no_recording_timeout": 123,
    "no_stream_timeout": 123
  },
  "recording_trigger": {
    "enabled": true,
    "start_type": "program_start",
    "stop_type": "break_end"
  },
  "region": "<string>",
  "settings": {},
  "tags": [
    "<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>"
}

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

PATCH

{space_id}

channels

{channel_id}

Update a channel

curl --request PATCH \
  --url https://api.up.telestream.com/capture/v1/{space_id}/channels/{channel_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "auto_shutdown": {
    "enabled": true,
    "no_recording_timeout": 123,
    "no_stream_timeout": 123
  },
  "description": "<string>",
  "name": "<string>",
  "recording_trigger": {
    "enabled": true
  },
  "region": "<string>",
  "settings": {},
  "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://api.up.telestream.com/capture/v1/{space_id}/channels/{channel_id}"

payload = {
    "auto_shutdown": {
        "enabled": True,
        "no_recording_timeout": 123,
        "no_stream_timeout": 123
    },
    "description": "<string>",
    "name": "<string>",
    "recording_trigger": { "enabled": True },
    "region": "<string>",
    "settings": {},
    "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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({
    auto_shutdown: {enabled: true, no_recording_timeout: 123, no_stream_timeout: 123},
    description: '<string>',
    name: '<string>',
    recording_trigger: {enabled: true},
    region: '<string>',
    settings: {},
    source_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    tags: ['<string>']
  })
};

fetch('https://api.up.telestream.com/capture/v1/{space_id}/channels/{channel_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/capture/v1/{space_id}/channels/{channel_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([
    'auto_shutdown' => [
        'enabled' => true,
        'no_recording_timeout' => 123,
        'no_stream_timeout' => 123
    ],
    'description' => '<string>',
    'name' => '<string>',
    'recording_trigger' => [
        'enabled' => true
    ],
    'region' => '<string>',
    'settings' => [
        
    ],
    'source_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    '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/capture/v1/{space_id}/channels/{channel_id}"

	payload := strings.NewReader("{\n  \"auto_shutdown\": {\n    \"enabled\": true,\n    \"no_recording_timeout\": 123,\n    \"no_stream_timeout\": 123\n  },\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"recording_trigger\": {\n    \"enabled\": true\n  },\n  \"region\": \"<string>\",\n  \"settings\": {},\n  \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\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/capture/v1/{space_id}/channels/{channel_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"auto_shutdown\": {\n    \"enabled\": true,\n    \"no_recording_timeout\": 123,\n    \"no_stream_timeout\": 123\n  },\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"recording_trigger\": {\n    \"enabled\": true\n  },\n  \"region\": \"<string>\",\n  \"settings\": {},\n  \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.up.telestream.com/capture/v1/{space_id}/channels/{channel_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  \"auto_shutdown\": {\n    \"enabled\": true,\n    \"no_recording_timeout\": 123,\n    \"no_stream_timeout\": 123\n  },\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"recording_trigger\": {\n    \"enabled\": true\n  },\n  \"region\": \"<string>\",\n  \"settings\": {},\n  \"source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

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

{
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "pinned": true,
  "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "draft",
  "activated_at": "2023-11-07T05:31:56Z",
  "auto_shutdown": {
    "enabled": true,
    "no_recording_timeout": 123,
    "no_stream_timeout": 123
  },
  "recording_trigger": {
    "enabled": true,
    "start_type": "program_start",
    "stop_type": "break_end"
  },
  "region": "<string>",
  "settings": {},
  "tags": [
    "<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>"
}

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

space_id

string<uuid>

required

The space to act in.

channel_id

string<uuid>

required

The channel's id.

Body

application/json

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

auto_shutdown

object | null

When the channel deactivates itself.

Show child attributes

description

string

name

string

Identifies the channel.

Required string length: 1 - 512

recording_trigger

object | null

The SCTE-35 cues that start and stop recording.

Show child attributes

region

string | null

Maximum string length: 30

settings

object

How the channel should behave beyond recording. It has to follow the channel settings schema of the engine version the channel records with; a document that does not is refused.

source_id

string<uuid>

The live source the channel records, of any UUID version.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

The updated channel.

A channel's configuration and lifecycle state. Its recording settings and its recordings are separate sub-resources, so listing channels stays a single query.

description

string

required

string<uuid>

required

name

string

required

pinned

boolean

required

read-only

Whether the channel is pinned to the top of the list. Read-only; no operation sets it.

source_id

string<uuid>

required

The live source the channel records.

status

enum<string>

required

draft is not fully configured and cannot be activated; inactive is configured but not activated; pending is being provisioned; active can record its source.

Available options:

draft,

inactive,

pending,

active

activated_at

string<date-time>

auto_shutdown

object

When the channel deactivates itself.

Show child attributes

recording_trigger

object

The SCTE-35 cues that start and stop recording.

Show child attributes

region

string

Where the recording worker is placed.

settings

object

How the channel behaves beyond recording. Its shape is the channel settings schema of the engine version the channel records with.