Get channel list

Available in Classic and VPC

Get the live channel list.

Request

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

Method	URI
GET	/api/v2/channels

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`pageNo`	Integer	Optional	Page number 1-N
`pageSizeNo`	Integer	Optional	Number of items per page 1-100
`channelStatus`	String	Optional	Filter by channel status. `CREATING` \| `READY` \| `PUBLISHING` \| `DELETED` \| `BLOCK` \| `FORCE_BLOCK` \| `FORCE_DELETED` `CREATING`: Creating `READY`: Ready `PUBLISHING`: Streaming `DELETED`: Terminated `BLOCK`: Stopped `FORCE_BLOCK`: Force stopped `FORCE_DELETED`: Unavailable
`id`	String	Optional	Filter by channel ID. Display values that match in whole or in part.
`channelName`	String	Optional	Filter by channel name. Display values that match in whole or in part.

Request headers

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

Request example

The request example is as follows:

curl --location --request GET 'https://livestation.apigw.ntruss.com/api/v2/channels?pageNo=1&pageSizeNo=1&channelName=chan' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json'

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
`channelId`	String	-	Channel ID
`channelName`	String	-	Channel name
`instanceNo`	Integer	-	Channel instance number
`qualitySetId`	Integer	-	Image quality setting ID
`qualitySetName`	String	-	Image quality setting name
`outputProtocol`	String	-	Output Protocol
`channelStatus`	String	-	Channel status `CREATING` \| `READY` \| `PUBLISHING` \| `DELETED` \| `BLOCK` \| `FORCE_BLOCK` \| `FORCE_DELETED` `CREATING`: Creating `READY`: Ready `PUBLISHING`: Streaming `DELETED`: Terminated `BLOCK`: Stopped `FORCE_BLOCK`: Force stopped `FORCE_DELETED`: Unavailable
`isRecording`	Boolean	-	Recording status `true` \| `false` `true`: Recording `false`: Not recording
`useDVR`	Boolean	-	Time machine settings `true` \| `false` `true`: Enable `false`: Disable
`immediateOnAir`	Boolean	-	Whether to set up auto-recording immediately upon streaming `true` \| `false` `true`: Automatic `false`: Manual
`timemachineMin`	Integer	-	Time Machine allowance (minute)
`cdn`	Object	-	Set up CDN.
`cdn.instanceNo`	String	-	CDN instance ID
`cdn.serviceName`	String	-	CDN service name
`cdn.statusName`	String	-	CDN status `RUNNING` \| `PUBLISHING` \| `STOPPING` \| `STOPPED` \| `CREATING` \| `CHANGING` \| `CDN_NOT_FOUND` `RUNNING`: Running `PUBLISHING`: Deploying `STOPPING`: Stopping `STOPPED`: Stopped `CREATING`: Creating `CHANGING`: Changing `CDN_NOT_FOUND`: CDN not found
`cdn.cdnType`	String	-	CDN type `GLOBAL_CDN` \| `GLOBAL_EDGE`
`cdn.cdnDomain`	String	-	CDN service domain
`cdn.profileId`	Integer	-	Global Edge profile ID
`cdn.regionType`	String	-	Global Edge Service Region
`streamKey`	String	-	Main stream key
`publishUrl`	String	-	Default transmission URL
`globalPublishUrl`	String	-	Overseas streaming URL
`totalPublishSeconds`	Integer	-	Channel usage time (second)
`createdTime`	Integer	-	Channel creation date and time (millisecond) Unix timestamp format
`alertOn`	Boolean	-	Event notification settings `true` \| `false` `true`: Enable `false`: Disable
`recentPublishStartTime`	Integer	-	Latest streaming start date and time (millisecond) Unix timestamp format Not displayed if it is before the first streaming
`alertOptions`	Object	-	Set event notifications.
`alertOptions.alertChangeStatus`	Boolean	-	Channel status change notification application `true` \| `false` `true`: Apply `false`: Not apply
`alertOptions.alertVodUploadFail`	Boolean	-	Recording file upload failure notification application `true` \| `false` `true`: Apply `false`: Not apply
`alertOptions.alertReStreamFail`	Boolean	-	Re-stream relay failure notification application `true` \| `false` `true`: Apply `false`: Not apply
`alertOptions.reStreamFailThreshold`	Integer	-	Notification condition (base count)
`alertOptions.alertStreamFailOver`	Boolean	-	Main stream switch notification application `true` \| `false` `true`: Apply `false`: Not apply
`callbackEndpoint`	String	-	Callback endpoint URL Displayed if a valid value exists
`envType`	String	-	Channel type `DEV` \| `STAGE` \| `REAL`
`uploadPath`	String	-	Recording file upload path Display if `record.type` is `AUTO_UPLOAD`.
`record`	Object	-	Recording storage information
`record.type`	String	-	Recording storage settings `NO_RECORD` \| `AUTO_UPLOAD` \| `MANUAL_UPLOAD` `NO_RECORD`: No recording `AUTO_UPLOAD`: Save automatically `MANUAL_UPLOAD`: Save temporarily
`record.bucketName`	String	-	Recording file storage bucket name Display if `record.type` is `AUTO_UPLOAD`.
`record.filePath`	String	-	Storage detailed path Display if `record.type` is `AUTO_UPLOAD`.
`record.format`	String	-	Automatic save recording type `MP4` \| `HLS` \| `ALL`
`record.accessControl`	String	-	Recording file storage bucket disclosure scope `PRIVATE` \| `PUBLIC_READ` `PRIVATE`: Private `PUBLIC_READ`: Public Display if `record.type` is `AUTO_UPLOAD`.
`snapshot`	Object	-	Snapshot information Displayed only if a snapshot is created during streaming
`snapshot.snapshotId`	Integer	-	Snapshot ID
`origin`	Object	-	Source information
`origin.originDomain`	String	-	Origin domain
`origin.originPath`	String	-	Origin path
`backupStreamKey`	String	-	Backup stream key Displayed when setting up streaming redundancy
`isStreamFailOver`	Boolean	-	Streaming redundancy settings `true` \| `false` `true`: Enable `false`: Disable
`drmEnabledYn`	Boolean	-	Multi DRM usage `true` \| `false` `true`: Enable `false`: Disable
`drm`	Object	-	Multi DRM settings If `drmEnabledYn` is `true`, display sub-information.
`drm.siteId`	String	-	Site ID
`drm.contentId`	String	-	Content ID

Response status codes

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

Response example

The response example is as follows:

{
    "content": [
        {
            "channelId": "ls-20250813******-SkhxV",
            "channelName": "mychannel",
            "instanceNo": 10*****39,
            "qualitySetId": 2584,
            "qualitySetName": "ll-audio-only",
            "outputProtocol": "LL_HLS",
            "channelStatus": "READY",
            "isRecording": false,
            "useDVR": true,
            "immediateOnAir": true,
            "timemachineMin": 360,
            "cdn": {
                "instanceNo": "11565",
                "serviceName": "edge-ls-20250813******-SkhxV",
                "statusName": "RUNNING",
                "cdnType": "GLOBAL_EDGE",
                "cdnDomain": "cj***********.edge.naverncp.com",
                "profileId": 4207,
                "regionType": "KOREA"
            },
            "streamKey": "y******************************n",
            "publishUrl": "rtmp://***********.video.media.ntruss.com:8080/relay",
            "globalPublishUrl": "rtmp://***************.video.media.ntruss.com:8080/relay",
            "totalPublishSeconds": 237,
            "createdTime": 1755070375000,
            "alertOn": true,
            "recentPublishStartTime": 1755128792000,
            "alertOptions": {
                "alertChangeStatus": true,
                "alertVodUploadFail": true,
                "alertReStreamFail": false,
                "reStreamFailThreshold": 2,
                "alertStreamFailOver": true
            },
            "callbackEndpoint": "https://www.example.com",
            "envType": "DEV",
            "uploadPath": "/mybucket/",
            "record": {
                "type": "AUTO_UPLOAD",
                "bucketName": "mybucket",
                "filePath": "/",
                "format": "MP4",
                "accessControl": "PRIVATE"
            },
            "origin": {
                "originDomain": "*****.video.media.ntruss.com",
                "originPath": "2*****5"
            },
            "backupStreamKey": "y******************************************e",
            "isStreamFailOver": true,
            "drmEnabledYn": false
        }
    ],
    "total": 2
}