> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://mediakind.ferndocs.com/harmonic/api/vos/playout-backend/toggle-source-input/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server. # Toggle source input switch for an ON-AIR or OFF-AIR source when input redundancy is used POST https://device.example.com:443/cluster1/vos-api/playoutcontrol/v1/livesources/{channelId}/switch_input Content-Type: application/json Reference: https://mediakind.ferndocs.com/harmonic/api/vos/playout-backend/toggle-source-input ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `channelId` (string, required) — ID of the channel ### Body (application/json) This endpoint expects a com.harmonicinc.vos.app.playoutcontrolbackend.rest.model.ToggleSourceInput. - `inputRankIndex` (integer, required) — Input rank to switch to. Value 1 or 2. - `serviceId` (string, required) — Id of the service this command applies to. - `sourceId` (string, required) — Id of the source this command applies to. This source shall contain 2 inputs. ## Response ### 200 Toggle source input command triggered ### 201 Created ## Errors ### 400 Bad Request Error Invalid request - `any` ### 401 Unauthorized Error Unauthorized - `any` ### 403 Forbidden Error Forbidden - `any` ### 404 Not Found Error ChannelId, ServiceId or SourceId doesn't exist - `any` ### 500 Internal Server Error Internal Error - `any` ## Examples ### Example 1 **Request** ```json { "inputRankIndex": 1, "serviceId": "string", "sourceId": "string" } ``` **Response** ```json {} ``` **SDK Code** ```python import requests url = "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input" payload = { "inputRankIndex": 1, "serviceId": "string", "sourceId": "string" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"inputRankIndex":1,"serviceId":"string","sourceId":"string"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input" payload := strings.NewReader("{\n \"inputRankIndex\": 1,\n \"serviceId\": \"string\",\n \"sourceId\": \"string\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"inputRankIndex\": 1,\n \"serviceId\": \"string\",\n \"sourceId\": \"string\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"inputRankIndex\": 1,\n \"serviceId\": \"string\",\n \"sourceId\": \"string\"\n}") .asString(); ``` ```php request('POST', 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input', [ 'body' => '{ "inputRankIndex": 1, "serviceId": "string", "sourceId": "string" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"inputRankIndex\": 1,\n \"serviceId\": \"string\",\n \"sourceId\": \"string\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "inputRankIndex": 1, "serviceId": "string", "sourceId": "string" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ### Example 2 **Request** ```json { "inputRankIndex": 1, "serviceId": "string", "sourceId": "string" } ``` **Response** ```json {} ``` **SDK Code** ```python import requests url = "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input" payload = { "inputRankIndex": 1, "serviceId": "string", "sourceId": "string" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"inputRankIndex":1,"serviceId":"string","sourceId":"string"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input" payload := strings.NewReader("{\n \"inputRankIndex\": 1,\n \"serviceId\": \"string\",\n \"sourceId\": \"string\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"inputRankIndex\": 1,\n \"serviceId\": \"string\",\n \"sourceId\": \"string\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"inputRankIndex\": 1,\n \"serviceId\": \"string\",\n \"sourceId\": \"string\"\n}") .asString(); ``` ```php request('POST', 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input', [ 'body' => '{ "inputRankIndex": 1, "serviceId": "string", "sourceId": "string" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"inputRankIndex\": 1,\n \"serviceId\": \"string\",\n \"sourceId\": \"string\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "inputRankIndex": 1, "serviceId": "string", "sourceId": "string" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/livesources/channelId/switch_input")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```