Get channel list

Available in Classic and VPC

Get the re-stream channel list.

Request

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

Method	URI
GET	/api/v2/re-stream/channels

Request headers

For information about the headers common to all Live Station APIs, see Live 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
`pageSizeNo`	Integer	Optional	Number of items per page 1-100

Request example

The request example is as follows:

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

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
`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
`streamKey`	String	-	Stream key
`publishUrl`	String	-	Default transmission URL
`globalPublishUrl`	String	-	Overseas streaming URL
`planType`	String	-	Pricing plan type `STANDARD` \| `PROFESSIONAL` `STANDARD`: Re-stream up to 3 platforms. `PROFESSIONAL`: Re-stream up to 5 platforms.
`createdTime`	Integer	-	Channel creation date and time (millisecond) Unix timestamp format
`platformCount`	Integer	-	Re-stream platform count
`totalPublishSeconds`	Integer	-	Channel usage time (second)
`alertOn`	Boolean	-	Event notification settings `true` \| `false` `true`: Enable `false`: Disable
`isPublishing`	Boolean	-	Streaming status `true` \| `false` `true`: Streaming `false`: Not streaming
`alertOptions`	Object	-	Set event notifications.
`alertOptions.alertChangeStatus`	Boolean	-	Re-stream 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
`content.alertOptions.reStreamFailThreshold`	Integer	-	Notification occurrence condition (base count) Not displayed before initial notification settings
`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 `REAL` \| `DEV` \| `STAGE`

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-20250819******-Ik1QU",
            "channelName": "channel001",
            "instanceNo": 1082*****,
            "channelStatus": "READY",
            "streamKey": "zgarlukheigpxu******************",
            "publishUrl": "rtmp://***********.video.media.ntruss.com:8080/relay",
            "globalPublishUrl": "rtmp://***************.video.media.ntruss.com:8080/relay",
            "planType": "STANDARD",
            "createdTime": 1755571786000,
            "platformCount": 2,
            "totalPublishSeconds": 0,
            "alertOn": false,
            "isPublishing": false,
            "alertOptions": {
                "alertChangeStatus": false,
                "alertVodUploadFail": false,
                "alertReStreamFail": false,
                "alertStreamFailOver": false
            },
            "callbackEndpoint": "https://www.example.com",
            "envType": "REAL"
        }
    ],
    "total": 2
}