Delete channel
- Print
- PDF
Delete channel
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
VOD Station provides an API to delete the created channels.
You can only delete channels in Stopped status.
Requests
DELETE https://vodstation.apigw.ntruss.com/api/v2/channels/{channelId}
Request headers
Header name | Description |
---|---|
x-ncp-region_code | NAVER Cloud Platform's Region code x-ncp_region_code:{Region Code} |
x-ncp-apigw-timestamp | 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 | Access key ID value issued from NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
x-ncp-apigw-signature-v2 | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
Responses
Field name | Type | Description | Note |
---|---|---|---|
content | Object | VOD Station OPEN API response object | |
content.id | String | ID of the created channel | |
content.name | Object | Channel name | |
content.channelStatus | Integer | Channel's current status | CREATING, READY, STOPPING, STOPPED, TERMINATING, TERMINATED, FORCE_STOPPING, FORCE_STOPPED, FORCETERMINATING, FORCETERMINATED |
content.storageBucketName | String | The name of the Object Storage bucket integrated with the channel | |
content.encryptedBucketName | String | Encrypted name of the Object Storage bucket integrated with the channel, used when creating the playback URL | |
content.accessPrivateFiles | Boolean | Set access restrictions on VOD Station for private files in the bucket | |
content.segmentDuration | Integer | Channel's segment duration (unit: second) | |
content.segmentDurationOption | String | Channel's segment keyframe alignment options | |
content.protocolList[] | Array(String) | List of streaming protocols of the channel | |
content.createTime | Integer | The time channel creation started | |
content.readyTime | Integer | The time channel creation was completed | |
content.cdnCreatedTime | Integer | The time when the CDN is automatically created with a channel | |
content.playUrl | String | CDN-based playback URL template | |
content.cdnStatus | String | Status of the CDN integrated with the channel. If not auto-generated, displayed as NOT_FOUND | |
content.cdnDomain | String | Domain of the automatically created CDN | |
content.cdnServiceName | String | Service name of the automatically created CDN | |
content.storageBucketStatus | String | Status of the Object Storage bucket integrated with the channel | |
content.originPath | String | This is referred to when an independent CDN is created using the original path of the created channel | |
content.encryptionList[] | Array | Media security settings of the channel | |
content.encryptionList[].protocol | String | Media security target protocol | |
content.encryptionList[].mediaEncryptionTypeCode | Integer | Media security setting's encryption type 1: AES-128 2: Sample-AES 3: CENC | |
content.encryptionList[].drmTypeCode | Intenger | Media security setting's DRM type 21: FairPlay 22: Widevine/PlayReady | |
content.encryptionList[].drmTypeName | String | Name of the DRM type for the media security setting | |
content.encryptionList[].drmContentId | String | Content ID to be requested when packaging from VOD Station | |
content.encryptionList[].systemIdList | Array(String) | DRM System ID to be requested when packaging from VOD Station | |
content.encryptionList[].drmKeyUrl | String | DRM CPIX API URL to be requested when packaging from VOD Station | |
content.drm | Object | DRM Encryption settings using VOD Station | |
content.drm.siteId | String | Site id created through One Click Multi DRM product | |
content.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 (_) | |
error | Object | Error response code and message | |
error.errorCode | String | Error response code | |
error.message | String | Error response message | |
error.details | String | Detailed description of the error message Responds when an API Gateway error occurs |
Examples
Request examples
DELETE https://vodstation.apigw.ntruss.com/api/v2/channels/vs-20191227055342-vDVWH5l
DELETE /api/v2/channels/vs-20191227055342-vDVWH5l
HOST: vodstation.apigw.ntruss.com
x-ncp-region_code:KR
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
Response examples
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
{
"content": {
"id": "vs-20201112113327-Icwk9YO",
"name": "api-guide-drm",
"channelStatus": "TERMINATING",
"storageBucketName": "vodstation-bucket",
"encryptedBucketName": "zz0G2Esbn14HUBlaiZSVkg__",
"segmentDuration": 5,
"segmentDurationOption": "BASIC",
"accessPrivateFiles": true,
"protocolList": [
"HLS",
"DASH"
],
"createTime": 1605148407,
"cdnCreatedTime": 1605148407,
"playUrl": "https://example.cdn.ntruss.com/[protocol]/[Object Storage Bucket(encryption name)]/[path]/[video filename]/[manifest]",
"cdnStatus": "NOT_FOUND",
"cdnDomain": "example.cdn.ntruss.com",
"cdnServiceName": "vscdn-Icwk9YO",
"storageBucketStatus": "RUNNING",
"originPath": "vs-k1.video.media.ntruss.com/132/vs-20201112113327-Icwk9YO",
"drm": {
"siteId": "ABCD",
"contentId": "abc-2344-dfd"
},
"encryptList": [
{
"protocol": "DASH",
"mediaEncryptTypeCode": 3,
"mediaEncryptionTypeName": "AES-128",
"drmTypeCode": 22,
"drmTypeName": "Widevine/PlayReady",
"drmContentId": "openapi",
"systemIdList": [
"9A04F079-9840-4286-AB92-E65BE0885F95",
"EDEF8BA9-79D6-4ACE-A3C8-27DCD51D21ED"
],
"drmKeyUrl": "https://kms.example.com/cpix/token"
},
{
"protocol": "HLS",
"mediaEncryptTypeCode": 1,
"mediaEncryptionTypeName": "AES-128"
}
]
}
}
Was this article helpful?