> 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/get-channel-settings/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server.

# Get channel settings

GET https://device.example.com:443/cluster1/vos-api/playoutcontrol/v1/channels/{channelId}/settings

Reference: https://mediakind.ferndocs.com/harmonic/api/vos/playout-backend/get-channel-settings

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `channelId` (string, required) — ID of the channel

## Response

### 200

OK

- `channelOverride` (enum, optional) — Enable channel override on playout channel
  - Allowed values: `NOTAVAILABLE`, `OFF`, `ON`
- `defaultLiveSource` (com.harmonicinc.vos.app.playoutcontrolbackend.channelmanager.DefaultLiveSourceSettings, optional)
- `enableGap` (boolean, optional) — Enable gap on the playout channel
- `enableLiveSourceMonitoring` (boolean, optional) — Enable live source monitoring on the playout channel
- `liveSourceLockoutTime` (integer, optional) — Live input lockout time, in secondes, used by the automation controls to determine live source monitoring priority
- `localTimeZone` (string, optional) — Time zone configured for the playout channel
- `playlistOffset` (integer, optional) — Offset applied to the playlist to have a short latency
- `scheduleReplacementLockoutTime` (integer, optional) — Lockout time applied to replace a schedule
- `uiSettings` (string, optional)

## Errors

### 400 Bad Request Error

Invalid request

- `any`

### 401 Unauthorized Error

Unauthorized

- `any`

### 403 Forbidden Error

Forbidden

- `any`

### 404 Not Found Error

Channel not found

- `any`

## Types

### com.harmonicinc.vos.app.playoutcontrolbackend.channelmanager.DefaultLiveSourceSettings

- `active` (enum, required) — PRIMARY when using the default live source, SECONDARY when using the secondary default live source.
  - Allowed values: `PRIMARY`, `SECONDARY`
- `primary` (string, required) — default live input name defined in playout input of the source of the service.
- `secondary` (string, optional) — secondaryDefaultLiveInputName defined in playout input of the source of the service (absent if not defined).
- `stableDurationBeforeRevertDefaultLiveInSeconds` (integer, optional) — stable duration before revert to default live input in seconds used when switch mode is AUTO_REVERT_ON_STABLE_PRIMARY.
- `switchMode` (enum, optional) — default live input switch mode.
  - Allowed values: `AUTO_REVERT_ON_SECONDARY_FAILURE`, `MANUAL`, `AUTO_REVERT_ON_STABLE_PRIMARY`

## Examples

**Response**

```json
{
  "channelOverride": "NOTAVAILABLE",
  "defaultLiveSource": {
    "active": "PRIMARY",
    "primary": "string",
    "secondary": "string",
    "stableDurationBeforeRevertDefaultLiveInSeconds": 1,
    "switchMode": "AUTO_REVERT_ON_SECONDARY_FAILURE"
  },
  "enableGap": true,
  "enableLiveSourceMonitoring": true,
  "liveSourceLockoutTime": 1,
  "localTimeZone": "string",
  "playlistOffset": 1,
  "scheduleReplacementLockoutTime": 1,
  "uiSettings": "string"
}
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/channels/channelId/settings"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/channels/channelId/settings';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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"
	"net/http"
	"io"
)

func main() {

	url := "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/channels/channelId/settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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/channels/channelId/settings")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/channels/channelId/settings")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://device.example.com/cluster1/vos-api/playoutcontrol/v1/channels/channelId/settings', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/playoutcontrol/v1/channels/channelId/settings");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/playoutcontrol/v1/channels/channelId/settings")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```