Edit channel settings
- Print
- PDF
Edit channel settings
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
An API that can edit the VOD channel settings created in Live Station.
Caution
Settings can only be edited when the VOD channel status is "READY" or "RESERVED."
Requests
PUT https://livestation.apigw.ntruss.com/api/v2/vod/channels/{channelId}
Request headers
Header name | Required | Description |
---|---|---|
x-ncp-apigw-timestamp | YES | Time elapsed since January 1, 1970 00:00:00 UTC in milliseconds. The request is considered invalid if the time difference compared to the API Gateway server is 5 minutes or longerx-ncp-apigw-timestamp:{Timestamp} |
x-ncp-iam-access-key | YES | Access key ID value issued from 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 bodies
Field name | Required | Type | Service limits | Description |
---|---|---|---|---|
channelName | Yes | String | 3 to 20 characters can be entered Underscores (_) allowed | Name of the channel to be created |
outputProtocol | Optional | String | HLS / HLS,DASH / LL_HLS | Output protocol settings Will be set to HLS if not entered Switching between HLS/HLS and DASH protocols and LL_HLS protocol is not supported. |
envType | Optional | String | DEV, STAGE, REAL | Usage classification settings for the created channel Will be set to REAL if not entered |
Responses
Field name | Type | Description | Note |
---|---|---|---|
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 | CDN_PLUS, GLOBAL_CDN, GLOBAL_EDGE | |
cdn.instanceNo | String | If NO_CDN, 0 | |
cdn.profileId | Integer | Profile ID of Global Edge | If NO_CDN, 0 |
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 | Responds only if schedule exists | |
scheduleList.scheduleId | Integer | ||
scheduleList.status | String | ||
drmEnabledYn | Boolean | Whether to apply DRM Encryption settings | |
drm | Object | DRM Encryption settings using Live Station When setting DRM, FairPlay and Widevine/PlayReady DRM are supported | |
drm.siteId | String | Site id created through One Click Multi DRM product | |
drm.contentId | String | Unique ID of content where DRM Encryption is applied Used for DRM packaging. You can enter 3 to 100 characters using English letters, numbers, hyphens (-), and underscores (_). |
Examples
Request examples
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 examples
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": "cdn-ls-20200323114720-bMoDF",
"statusName": "running",
"cdnType": "CDN_PLUS",
"cdnDomain": "mycdn.cdn.ntruss.com"
},
"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?