Create channel

Article summary

Did you find this summary helpful?

Thank you for your feedback

This is an API that creates a VOD channel in Live Station. Channel list search API and Channel information search API are provided to search the created channels.

Set content protection

Live Station DRM Encryption supports multi-DRM for real-time content.
You can easily set the DRM feature in the DRM settings area in the channel creation, and it supports multi-DRM encryption depending on the selected OutputProtocol.
For more information about encryption methods by DRM technology and supported devices and other platforms and versions, see this link.

DRM type
- FairPlay: A DRM technology protocol provided by Apple. It encrypts each HLS segment with the AES-CBC method.
- Widevine: A DRM technology protocol provided by Google. It encrypts with the AES-128 method according to the Common Encryption Standard.
- PlayReady: A DRM technology protocol provided by Microsoft. It encrypts with the AES-128 method according to the Common Encryption Standard.

Request

POST https://livestation.apigw.ntruss.com/api/v2/vod/channels

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 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	YES	Access key ID value issued on NAVER Cloud Platform portal `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	YES	Signature encrypted with the access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	YES	Specify the request body content type as application/json `Content-Type: application/json`
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
envType	Optional	String	DEV, STAGE, REAL	Settings for usage classification of the channel to be created Set to REAL if not entered
cdn	Yes	Object		CDN Object
cdn.createCdn	Yes	Boolean	true, false	CDN Object
cdn.cdnType	Yes	String	GLOBAL_CDN,GLOBAL_EDGE	CDN+ not supported
cdn.profileId	Yes	Integer		Global Edge profile required for new GLOBAL_EDGE creation
cdn.regionType	Yes	String	KOREA,JAPAN,GLOBAL	Global Edge service area
cdn.cdnInstanceNo	Optional	Integer		Must be set if cdn.createCdn is false
qualitySetId	Yes	Integer
drmEnabledYn	Yes	Boolean		Whether DRM encryption settings are applied
drm	Optional	Object		Set DRM encryption using Live Station When setting DRM, FairPlay, Widevine/PlayReady DRMs are supported
drm.siteId	Optional	String		Site id created with One Click Multi DRM product
drm.contentId	Optional	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)

Response

Field name	Type	Description	Remarks
channelId	String
channelName	String
outputProtocol	String	HLS HLS, DASH LL_HLS
envType	String	DEV, STAGE, REAL
cdn	Object
cdn.createCdn	Boolean
cdn.cdnType	String	GLOBAL_CDN,GLOBAL_EDGE
cdn.profileId	Integer	Global Edge profile required for new GLOBAL_EDGE creation
cdn.regionType	String	Global Edge service area	KOREA,JAPAN,GLOBAL
cdn.cdnInstanceNo	Integer		Must be set if cdn.createCdn is false
qualitySetId	Integer
type	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

POST /api/v2/vod/channels
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 (if cdn.createCdn == true) 
{
  "channelName": "myTestChannel",
  "cdn": {
    "createCdn": true,
    "cdnType": "GLOBAL_EDGE"
  },
  "qualitySetId": 5,
  "envType": "REAL",
  "outputProtocol": "HLS",
  "drmEnabledYn": true,
  "drm": {
    "siteId": "drm-20231115142326-nHyNw",
    "contentId": "my-Test-Multidrm"
  }
}

Request body (if cdn.createCdn == false) 
{
    "channelName": "myTestChannel",
    "cdn": {
      "createCdn": false,
      "cdnType": "GLOBAL_EDGE",
      "cdnDomain": "mycdn.edge.naverncp.com",
      "profileId": 299,
      "cdnInstanceNo": 1541959,
      "regionType": "KOREA"
    },
    "qualitySetId": 4,
    "envType": "REAL",
    "outputProtocol": "HLS",
    "drmEnabledYn": true,
    "drm": {
        "siteId": "drm-20231115142326-nHyNw",
        "contentId": "my-Test-Multidrm"
    }
}

Response example

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 26 Feb 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": {
    "channelName": "myTestChannel",
    "cdn": {
      "createCdn": false,
      "cdnType": "GLOBAL_EDGE",
      "cdnDomain": "mycdn.edge.naverncp.com",
      "profileId": 299,
      "cdnInstanceNo": 1541959,
      "regionType": "KOREA"
    },
    "qualitySetId": 4,
    "envType": "REAL",
    "outputProtocol": "HLS",
    "channelId": "ls-20211122220557-mUv3r",
    "type": "VOD",
    "drmEnabledYn": true,
    "drm": {
        "siteId": "drm-20231115142326-nHyNw",
        "contentId": "my-Test-Multidrm"
    }
  }
}

Was this article helpful?

What's Next

Delete channel

Table of contents

Request
Response
Examples