Get channel list

Available in Classic and VPC

Get the channel list.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/api/v2/channels

Request headers

For information about the headers common to all VOD Station APIs, see VOD Station request headers.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`pageNo`	Integer	Optional	Page number 1-N (default: 1)
`pageSizeNo`	Integer	Optional	Number of items per page 1-N (default: 20)

Request example

The request example is as follows:

curl --location --request GET 'https://vodstation.apigw.ntruss.com/api/v2/channels?pageNo=1&pageSizeNo=20' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`content`	Array	-	Channel list: content
`total`	Integer	-	Total response count

`content`

The following describes content.

Field	Type	Required	Description
`disabled`	Boolean	-	Whether Sub Account is disabled `true` \| `false` `true`: Disabled `false`: Enabled
`id`	String	-	Channel ID
`name`	String	-	Channel name
`channelStatus`	String	-	Channel status `CREATING` \| `READY` \| `STOPPING` \| `STOPPED` \| `TERMINATING` \| `TERMINATED` \| `FORCE_STOPPING` \| `FORCE_STOPPED` \| `FORCETERMINATING` \| `FORCETERMINATED` `CREATING`: Creating `READY`: Running `STOPPING`: Stopping `STOPPED`: Stopped `TERMINATING`: Deleting `TERMINATED`: Deleted `FORCE_STOPPING`: Force stopping `FORCE_STOPPED`: Force stopped `FORCETERMINATING`: Force deleting `FORCETERMINATED`: Force deleted
`storageBucketName`	String	-	Name of the bucket where the video the channel will stream is stored
`segmentDuration`	Integer	-	Playback time per segment (second)
`protocolList`	Array	-	List of streaming protocols `HLS` \| `DASH`
`createTime`	Integer	-	Channel creation start date and time (millisecond) Unix timestamp format
`readyTime`	Integer	-	Channel creation completion date and time (millisecond) Unix timestamp format
`cdnCreatedTime`	Integer	-	Date and time when the CDN was automatically created in integration with the channel Unix timestamp format
`stopTime`	Integer	-	Channel stop date and time (millisecond) Unix timestamp format Displayed if `channelStatus` is `STOPPED` (Stop completed)
`playUrl`	String	-	Playback URL template via CDN
`cdnStatus`	String	-	Status of the CDN integrated with the channel If not auto-generated, displayed as `NOT_FOUND`
`cdnDomain`	String	-	Auto-generated Global Edge's domain
`cdnServiceName`	String	-	Auto-generated Global Edge's service name
`storageBucketStatus`	String	-	Status of the Object Storage bucket integrated with the channel
`originPath`	String	-	Source path of the created channel Use when creating a separate CDN.
`encryptList`	Array	-	Content protection settings information for the channel: encryptList
`accessPrivateFiles`	Boolean	-	Whether to restrict access to private files in the bucket `true` \| `false` (default) `true`: Allow `false`: Restrict Private files can also be streamed if allowed.
`encryptedBucketName`	String	-	Encrypted name of the bucket integrated with the channel Use when creating the playback URL.
`segmentDurationOption`	String	-	Segmentation method settings `BASIC` \| `VARIABLE` `BASIC`: Create segments at regular intervals set by the `segmentDuration` setting. `VARIABLE`: Create segments so that every segment starts with a keyframe. If the `VARIABLE` option is selected, there is a possibility of a difference between the `segmentDuration` value and the actual generated segment playback time.
`cdn`	Object	-	Auto-generated CDN (Global Edge) information
`cdn.cdnType`	String	-	CDN type `GLOBAL_EDGE` (valid value)
`cdn.cdnDomain`	String	-	Auto-generated Global Edge's domain
`cdn.cdnServiceName`	String	-	Auto-generated Global Edge's service name
`cdn.profileId`	Integer	-	Auto-generated Global Edge's profile ID
`cdn.regionType`	String	-	Auto-generated Global Edge Service Region
`cdn.cdnInstanceNo`	Integer	-	Auto-generated Global Edge's instance information

`encryptList`

The following describes encryptList.

Field	Type	Required	Description
`drmContentId`	String	Optional	DRM content ID The value is included for DRM key requests and needed for license issuing.
`drmKeyUrl`	String	-	DRM key URL DRM provider's CPIX API URL VOD Station officially supports the integration with Inka Pallyacon DRM's CPIX v1 API.
`systemIdList`	Array	-	DRM system ID DRM system's unique identifier
`drmTypeCode`	Integer	Optional	DRM type `21` \| `22` `21`: FairPlay `22`: Widevine/PlayReady
`drmTypeName`	String	-	DRM type name
`protocol`	String	-	Set protocol `HLS` \| `DASH` `HLS`: FairPlay/Media Encryption `DASH`: Widevine/PlayReady
`mediaEncryptTypeCode`	Integer	Optional	Set Media Encryption (HLS AES-128) code settings `1` \| `2` \| `3` `1`: AES-128 `2`: Sample-AES `3`: CENC
`mediaEncryptionTypeName`	String	-	Set Media Encryption (HLS AES-128) type name `AES-128` \| `Sample-AES` \| `CENC`

Response status codes

For information about the HTTP status codes common to all VOD Station APIs, see VOD Station response status codes.

Response example

The response example is as follows:

{
    "content": [
        {
            "disabled": false,
            "id": "vs-20250821095732-*******",
            "name": "ch-media-encrypt",
            "channelStatus": "READY",
            "storageBucketName": "station-000",
            "segmentDuration": 10,
            "protocolList": [
                "HLS"
            ],
            "createTime": 1755737852,
            "readyTime": 1755737880,
            "cdnCreatedTime": 1755737852,
            "playUrl": "https://cpzplvi******.edge.naverncp.com/[protocol]/[Object Storage Bucket(encryption name)]/[path]/[video filename]/[manifest]",
            "cdnStatus": "RUNNING",
            "cdnDomain": "cpzplvi******.edge.naverncp.com",
            "cdnServiceName": "edge-vs-20250821095732-*******",
            "storageBucketStatus": "RUNNING",
            "originPath": "vs2-k1.video.media.ntruss.com/2706412/vs-20250821095732-*******",
            "encryptList": [
                {
                    "protocol": "HLS",
                    "mediaEncryptTypeCode": 1
                }
            ],
            "accessPrivateFiles": true,
            "encryptedBucketName": "*****VzPmKvIthkozoufHw__",
            "segmentDurationOption": "BASIC",
            "cdn": {
                "cdnType": "GLOBAL_EDGE",
                "cdnDomain": "cpzplvi******.edge.naverncp.com",
                "cdnServiceName": "edge-vs-20250821095732-*******",
                "profileId": ****,
                "regionType": "KOREA",
                "cdnInstanceNo": *****
            }
        }
    ],
    "total": 1
}