Stop channel

Available in Classic and VPC

Stop a VOD2LIVE channel in the RESERVED or PUBLISHING status.

Request

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

Method	URI
PUT	/api/v2/vod/channels/{channelId}/off

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`channelId`	String	Required	Channel ID See Get channel list.

Request example

The request example is as follows:

curl --location --request PUT 'https://livestation.apigw.ntruss.com/api/v2/vod/channels/ls-20250820******-FdJkJ/off' \
--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`	Object	-	Channel information
`content.channelId`	String	-	Channel ID
`content.channelName`	String	-	Channel name
`content.instanceNo`	Integer	-	Channel instance number
`content.qualitySetId`	Integer	-	Image quality setting ID
`content.qualitySetName`	String	-	Image quality setting name
`content.outputProtocol`	String	-	Output Protocol
`content.channelStatus`	String	-	Channel status `CREATING` \| `READY` \| `PUBLISHING` \| `DELETED` \| `BLOCK` \| `RESERVED` \| `FORCE_BLOCK` \| `FORCE_DELETED` `CREATING`: Creating `READY`: Ready `PUBLISHING`: Streaming `DELETED`: Terminated `BLOCK`: Stopped `RESERVED`: Streaming scheduled `FORCE_BLOCK`: Force stopped `FORCE_DELETED`: Unavailable
`content.cdn`	Object	-	Set up CDN.
`content.cdn.instanceNo`	String	-	CDN instance ID
`content.cdn.serviceName`	String	-	CDN service name
`content.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
`content.cdn.cdnType`	String	-	CDN type `GLOBAL_CDN` \| `GLOBAL_EDGE`
`content.cdn.cdnDomain`	String	-	CDN service domain
`content.cdn.profileId`	Integer	-	Global Edge profile ID
`content.cdn.regionType`	String	-	Global Edge Service Region
`content.totalPublishSeconds`	Integer	-	Channel usage time (second)
`content.createdTime`	Integer	-	Channel creation date and time (millisecond) Unix timestamp format
`content.updatedTime`	Integer	-	Channel update date and time (millisecond) Unix timestamp format
`content.alertOn`	Boolean	-	Event notification settings `true` \| `false` `true`: Enable `false`: Disable
`content.recentPublishTime`	Integer	-	Latest streaming start date and time (millisecond) Unix timestamp format Not displayed if it is before the first streaming
`content.alertOptions`	Object	-	Set event notifications.
`content.alertOptions.alertChangeStatus`	Boolean	-	Channel status change notification application `true` \| `false` `true`: Apply `false`: Not apply
`content.callbackEndpoint`	String	-	Callback endpoint URL Displayed if a valid value exists
`content.envType`	String	-	Channel type `DEV` \| `STAGE` \| `REAL`
`content.type`	String	-	Channel type `VOD`
`content.scheduleList`	Array	-	Schedule list: scheduleList
`content.drmEnabledYn`	Boolean	-	Multi DRM usage `true` \| `false` `true`: Enable `false`: Disable
`content.drm`	Object	-	Multi DRM settings If `content.drmEnabledYn` is `true`, display sub-information.
`content.drm.siteId`	String	-	Site ID
`content.drm.contentId`	String	-	Content ID

`scheduleList`

The following describes scheduleList.

Field	Type	Required	Description
`scheduleId`	Integer	-	Schedule ID
`status`	String	-	Schedule status

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-20250820******-FdJkJ",
        "channelName": "vl2_mychannel2",
        "instanceNo": 10******1,
        "qualitySetId": 4,
        "qualitySetName": "720p-set",
        "outputProtocol": "HLS",
        "channelStatus": "BLOCK",
        "cdn": {
            "instanceNo": "1****",
            "serviceName": "edge-ls-20250814*******-PZohi",
            "statusName": "RUNNING",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "*************.edge.naverncp.com",
            "profileId": 4207,
            "regionType": "KOREA"
        },
        "totalPublishSeconds": 0,
        "createdTime": 1755664159000,
        "updatedTime": 1755671721000,
        "alertOn": false,
        "alertOptions": {
            "alertChangeStatus": false
        },
        "callbackEndpoint": "https://www.example.com",
        "envType": "REAL",
        "type": "VOD",
        "scheduleList": [
            {
                "scheduleId": 1292,
                "status": "READY"
            }
        ],
        "drmEnabledYn": false
    }
}