> This page is for Harmonic.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server.

# Get a regional ads channel.

GET https://device.example.com:443/cluster1/vos-api/atm/v1/vcm/regional-ads-channels/{channel-name}

Get a regional ads channel.

Reference: https://mediakind.ferndocs.com/harmonic/api/vos/vcm-variant-channels/get-regional-ads-channel

## Authentication

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

## Request

### Path parameters

- `channel-name` (string, required) — The name of the regional ads channel.

## Response

### 200

OK

- `upstreamURL` (string, required) — The Content Source URL. (Only the manifest path, with manifest filename. Should end with '/')
- `channelName` (string, optional) — The channel name of the variant channel. Must be unique.
- `contentSegmentDeliveryPrefix` (com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix_DeliveryPrefix, optional)
- `deliveryMode` (enum, optional) — Delivery mode. If the value is null or DEFAULT, RELATIVE for VCM and RELATIVE_MASTER for PMM. Options: DEFAULT, RELATIVE_MASTER, ABSOLUTE, ABSOLUTE_MASTER, RELATIVE
  - Allowed values: `DEFAULT`, `ABSOLUTE`, `ABSOLUTE_MASTER`, `RELATIVE`, `RELATIVE_MASTER`
- `dvrWindowSize` (integer, optional) — DVR Window Size in Seconds.
- `enableDeltaUpdate` (boolean, optional) — Enable delta update of manipulated manifests.
- `enableIFrame` (boolean, optional) — True when enable IFrame stream in the resulting manifests. Supported for HLS only.
- `enableImageStream` (boolean, optional) — True when enable image stream in the resulting manifests. Supported for HLS only.
- `enableSCTE35Signal` (boolean, optional) — True when including SCTE35 signals in the resulting manifests.
- `enableSubtitle` (boolean, optional) — True when stitching the subtitle into the resulting manifests. Supported for HLS only.
- `geoSyncEnable` (boolean, optional) — Enable redundancy mode for VCM channel
- `manifestVariantDeliveryPrefix` (string, optional) — Delivery prefixes for HLS master variant URL
- `mediaID` (string, optional) — The SCTE224 Media ID
- `regionalAdTxProfile` (string, optional) — The ID of transcoding profile of regional ads.
- `segmentDeliveryPrefix` (map from string to com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix_SegmentDeliveryPrefix, optional) — Delivery prefixes for origin content

## Errors

### 401 Unauthorized Error

Unauthorized

- `any`

### 403 Forbidden Error

Forbidden

- `any`

### 404 Not Found Error

Not Found

- `any`

## Types

### com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix_DeliveryPrefix

- `DASH` (string, optional) — Delivery prefix for DASH package type
- `HLS` (string, optional) — Delivery prefix for HLS package type

### com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix_SegmentDeliveryPrefix

- `adSegmentDeliveryPrefix` (com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix_DeliveryPrefix, required)
- `contentSegmentDeliveryPrefix` (com.harmonicinc.vos.app.atm.rest.model.VariantChannelDeliveryPrefix_DeliveryPrefix, required)

## Examples

**Response**

```json
{
  "upstreamURL": "string",
  "channelName": "string",
  "contentSegmentDeliveryPrefix": {
    "DASH": "string",
    "HLS": "string"
  },
  "deliveryMode": "DEFAULT",
  "dvrWindowSize": 1,
  "enableDeltaUpdate": true,
  "enableIFrame": true,
  "enableImageStream": true,
  "enableSCTE35Signal": true,
  "enableSubtitle": true,
  "geoSyncEnable": true,
  "manifestVariantDeliveryPrefix": "string",
  "mediaID": "string",
  "regionalAdTxProfile": "string",
  "segmentDeliveryPrefix": {}
}
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/atm/v1/vcm/regional-ads-channels/channel-name"

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

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

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/atm/v1/vcm/regional-ads-channels/channel-name';
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/atm/v1/vcm/regional-ads-channels/channel-name"

	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/atm/v1/vcm/regional-ads-channels/channel-name")

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/atm/v1/vcm/regional-ads-channels/channel-name")
  .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/atm/v1/vcm/regional-ads-channels/channel-name', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/atm/v1/vcm/regional-ads-channels/channel-name");
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/atm/v1/vcm/regional-ads-channels/channel-name")! 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()
```