Replace a template
curl --request PUT \
--url https://api.up.telestream.com/capture/v1/{space_id}/recording_settings_templates/{template_name} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"engine_version": "<string>",
"settings": {}
}
'import requests
url = "https://api.up.telestream.com/capture/v1/{space_id}/recording_settings_templates/{template_name}"
payload = {
"engine_version": "<string>",
"settings": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({engine_version: '<string>', settings: {}})
};
fetch('https://api.up.telestream.com/capture/v1/{space_id}/recording_settings_templates/{template_name}', 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}/recording_settings_templates/{template_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'engine_version' => '<string>',
'settings' => [
]
]),
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}/recording_settings_templates/{template_name}"
payload := strings.NewReader("{\n \"engine_version\": \"<string>\",\n \"settings\": {}\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.up.telestream.com/capture/v1/{space_id}/recording_settings_templates/{template_name}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"engine_version\": \"<string>\",\n \"settings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.up.telestream.com/capture/v1/{space_id}/recording_settings_templates/{template_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"engine_version\": \"<string>\",\n \"settings\": {}\n}"
response = http.request(request)
puts response.read_body{
"engine_version": "<string>",
"settings": {}
}{
"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>"
}Recording settings templates
Replace a template
Requires the capture:channel-management permission.
PUT
/
{space_id}
/
recording_settings_templates
/
{template_name}
Replace a template
curl --request PUT \
--url https://api.up.telestream.com/capture/v1/{space_id}/recording_settings_templates/{template_name} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"engine_version": "<string>",
"settings": {}
}
'import requests
url = "https://api.up.telestream.com/capture/v1/{space_id}/recording_settings_templates/{template_name}"
payload = {
"engine_version": "<string>",
"settings": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({engine_version: '<string>', settings: {}})
};
fetch('https://api.up.telestream.com/capture/v1/{space_id}/recording_settings_templates/{template_name}', 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}/recording_settings_templates/{template_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'engine_version' => '<string>',
'settings' => [
]
]),
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}/recording_settings_templates/{template_name}"
payload := strings.NewReader("{\n \"engine_version\": \"<string>\",\n \"settings\": {}\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.up.telestream.com/capture/v1/{space_id}/recording_settings_templates/{template_name}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"engine_version\": \"<string>\",\n \"settings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.up.telestream.com/capture/v1/{space_id}/recording_settings_templates/{template_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"engine_version\": \"<string>\",\n \"settings\": {}\n}"
response = http.request(request)
puts response.read_body{
"engine_version": "<string>",
"settings": {}
}{
"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
A platform API key, presented as Authorization: Bearer <API_KEY>. Each operation says which permission the key needs.
Path Parameters
The space to act in.
The template's name, which identifies it within the space.
Required string length:
1 - 512Body
application/json
The engine version to pin, as major.minor.patch, or empty to follow the current engine. Pinning is not honoured: the value is kept, and the settings follow the current engine.
Maximum string length:
32How the channel should record. It follows the recording settings schema of the settings' engine version; a document that does not is stored all the same, and reported as not valid for recording.
Response
The updated template.
