Edit channel settings
- Print
- PDF
Edit channel settings
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
This is an API that can edit settings for a VOD channel created in Live Station.
Caution
Settings can only be changed when the VOD channel status is "READY" or "RESERVED."
Request
PUT https://livestation.apigw.ntruss.com/api/v2/vod/channels/{channelId}
Request headers
Header name | Required | Description |
---|---|---|
x-ncp-apigw-timestamp | YES | It indicates the elapsed time in milliseconds since January 1, 1970 00:00:00 UTC. Request is considered invalid if the timestamp differs from the current time by more than 5 minutesx-ncp-apigw-timestamp:{Timestamp} |
x-ncp-iam-access-key | YES | Access key ID value issued on NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
x-ncp-apigw-signature-v2 | YES | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
x-ncp-region_code | YES | Region code (KR) |
Request body
Field name | Required | Type | Restrictions | Description |
---|---|---|---|---|
channelName | Yes | String | Between 3 and 20 characters are allowed Special character underscore (_) is allowed | Name of the channel to create |
outputProtocol | Optional | String | HLS / HLS,DASH / LL_HLS | Set output protocols Set to HLS if not entered No support for switching back and forth between HLS/HLS,DASH and LL_HLS protocols |
envType | Optional | String | DEV, STAGE, REAL | Settings for usage classification of the channel to be created Set to REAL if not entered |
Response
Field name | Type | Description | Remarks |
---|---|---|---|
channelName | String | ||
channelId | String | ||
instanceNo | String | ||
channelStatus | String | CREATING, READY, PUBLISHING, DELETED, BLOCK,RESERVED, FORCE_BLOCK, FORCE_DELETED | |
createdTime | String | ||
cdn | Object | ||
cdn.cdnType | String | GLOBAL_CDN, GLOBAL_EDGE | |
cdn.instanceNo | String | 0 if NO_CDN | |
cdn.profileId | Integer | Profile ID of Global Edge | 0 if NO_CDN |
cdn.statusName | String | CDN status | RUNNING, PUBLISHING, STOPPING, STOPPED, CREATING, CHANGING, CDN_NOT_FOUND |
cdn.serviceName | String | CDN Service Name | "" if NO_CDN |
cdn.cdnDomain | String | CDN Domain | "" if NO_CDN |
qualitySetId | Integer | ||
qualitySetName | String | ||
outputProtocol | String | ||
alertOn | Boolean | ||
alertOptions | Object | ||
alertOptions.alertChangeStatus | Boolean | ||
totalPublishSeconds | Integer | ||
createdTime | Integer | ||
updatedTime | Integer | ||
envType | String | DEV, STAGE, REAL | |
type | String | VOD | |
callbackEndpoint | String | ||
scheduleList | Array | Respond only if schedules exist | |
scheduleList.scheduleId | Integer | ||
scheduleList.status | String | ||
drmEnabledYn | Boolean | Whether DRM encryption settings are applied | |
drm | Object | Set DRM encryption using Live Station When setting DRM, FairPlay, Widevine/PlayReady DRMs are supported | |
drm.siteId | String | Site id created with One Click Multi DRM product | |
drm.contentId | String | Unique ID of the content to apply DRM encryption to It is used for DRM packaging and can be at least 3 characters and up to 100 characters, including English letter, numbers, "-" (hyphen), and "_" (underscore) |
Examples
Request example
PUT /api/v2/vod/channels/ls-20210720153935-PjPQi
HOST: livestation.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1521787414578
x-ncp-iam-access-key: 6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2: iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
x-ncp-region_code: KR
//Request body
{
"channelName": "mychannel2",
"envType": "DEV",
"outputProtocol": "HLS",
}
Response example
HTTP/1.1 200 OK
Server: nginx
Date: Fri, 26 Sep 2021 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
{
"content": {
"channelId": "ls-20210720153935-PjPQi",
"channelName": "mychannel2",
"instanceNo": 1163899,
"qualitySetId": 6,
"qualitySetName": "360p-set",
"outputProtocol": "HLS",
"channelStatus": "READY",
"cdn": {
"instanceNo": "1163900",
"serviceName": "edge-ls-20200323114720-bMoDF",
"statusName": "RUNNING",
"cdnType": "GLOBAL_EDGE",
"cdnDomain": "mycdn.edge.naverncp.com",
"profileId": 299,
"regionType": "KOREA"
},
"totalPublishSeconds": 0,
"createdTime": 1584931640000,
"recentPublishStartTime": 0,
"alertOn": false,
"alertOptions": {
"alertChangeStatus": false,
},
"callbackEndpoint": "https://my-callback-endpoint",
"envType": "REAL",
"type": "VOD",
"drmEnabledYn": true,
"drm": {
"siteId": "drm-20231115142326-nHyNw",
"contentId": "my-Test-Multidrm"
}
}
}
Was this article helpful?