Edit channel settings
    • PDF

    Edit channel settings

    • PDF

    Article Summary

    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 nameRequiredDescription
    x-ncp-apigw-timestampYESTime 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 longer
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyYESAccess key ID value issued from NAVER Cloud Platform portal
    x-ncp-iam-access-key:{Sub Account Access Key}
    x-ncp-apigw-signature-v2YESSignature encrypted with the access key ID value and secret key
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    x-ncp-region_codeYESRegion code (KR)

    Request bodies

    Field nameRequiredTypeService limitsDescription
    channelNameYesString3 to 20 characters can be entered
    Underscores (_) allowed
    Name of the channel to be created
    outputProtocolOptionalStringHLS / HLS,DASH / LL_HLSOutput protocol settings
    Will be set to HLS if not entered
    Switching between HLS/HLS and DASH protocols and LL_HLS protocol is not supported.
    envTypeOptionalStringDEV, STAGE, REALUsage classification settings for the created channel
    Will be set to REAL if not entered

    Responses

    Field nameTypeDescriptionNote
    channelNameString
    channelIdString
    instanceNoString
    channelStatusStringCREATING, READY, PUBLISHING, DELETED, BLOCK,RESERVED, FORCE_BLOCK, FORCE_DELETED
    createdTimeString
    cdnObject
    cdn.cdnTypeStringCDN_PLUS, GLOBAL_CDN, GLOBAL_EDGE
    cdn.instanceNoStringIf NO_CDN, 0
    cdn.profileIdIntegerProfile ID of Global EdgeIf NO_CDN, 0
    cdn.statusNameStringCDN statusRUNNING, PUBLISHING, STOPPING, STOPPED, CREATING, CHANGING, CDN_NOT_FOUND
    cdn.serviceNameStringCDN Service NameIf NO_CDN, ""
    cdn.cdnDomainStringCDN DomainIf NO_CDN, ""
    qualitySetIdInteger
    qualitySetNameString
    outputProtocolString
    alertOnBoolean
    alertOptionsObject
    alertOptions.alertChangeStatusBoolean
    totalPublishSecondsInteger
    createdTimeInteger
    updatedTimeInteger
    envTypeStringDEV, STAGE, REAL
    typeStringVOD
    callbackEndpointString
    scheduleListArrayResponds only if schedule exists
    scheduleList.scheduleIdInteger
    scheduleList.statusString
    drmEnabledYnBooleanWhether to apply DRM Encryption settings
    drmObjectDRM Encryption settings using Live Station
    When setting DRM, FairPlay and Widevine/PlayReady DRM are supported
    drm.siteIdStringSite id created through One Click Multi DRM product
    drm.contentIdStringUnique 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?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.