Edit site
    • PDF

    Edit site

    • PDF

    Article summary

    One Click Multi DRM provides an API to edit the created site.

    Requests

    PUT https://multi-drm.apigw.ntruss.com/api/v1/sites/{siteId}
    

    Request headers

    Header nameRequirement statusDescription
    x-ncp-apigw-timestampYESThis is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 (UTC)
    If the time difference compared to the API Gateway server is 5 minutes or longer, then the request is considered invalid
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyYESValue of access key ID issued in the 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}
    Content-TypeYESSpecifies the request body content type as application/json
    Content-Type: application/json
    x-ncp-region_codeYESRegion code (KR)

    Request body

    Field nameRequirement statusTypeRestrictionsDescription
    siteNameYesStringThis must be between 3 and 20 characters in length
    Special character hyphens (-) are allowed
    Name of the site to be created
    policyIdYesIntegerdefault policyId : 0Playback and security policy according to DRM type used during DRM application
    fairPlayCertOptionalObjectFairplay certification for FairPlay Streaming DRM application
    fairPlayCert.certFileOptionalStringOnly supports *.der or *.cer fileFairPlay Streaming certificate acquired from Apple
    Only supports http download URL
    fairPlayCert.privateKeyOptionalStringOnly supports *.pem filesPrivate key file of the FairPlay Streaming certificate acquired from Apple
    Only supports http download URL
    fairPlayCert.privateEncryptedStringOptionalStringPrivate key acquired upon Fairplay Streaming certificate issuance
    fairPlayCert.secretKeyOptionalStringApplication secret key (ASK) string acquired upon Fairplay Streaming certificate issuance

    Examples

    Request example

    {
      "policyId": 0,
      "siteName": "myFirstDrmConfig"
    }
    

    Response example

    Field nameRequirement statusTypeRestrictionDescription
    siteNameYesStringThis must be between 3 and 20 characters in length
    Special character (underscore) allowed
    Name of the site to be created
    siteIdYesStringUnique ID of the created site
    siteEnabledYnYesBooleanSite activation status
    siteStatusYesStringCREATING,READY,RUNNING,DELETEDCondition of the created site
    policyIdYesIntegerdefault policyId : 0Playback and security policy according to DRM type used during DRM application
    fairPlayCertOptionalObjectFairplay certification for FairPlay Streaming DRM application
    fairPlayCert.certFileOptionalStringOnly supports *.der or *.cer fileFairPlay Streaming certificate acquired from Apple
    Only supports http download URL
    fairPlayCert.privateKeyOptionalStringOnly supports *.pem filesPrivate key file of the FairPlay Streaming certificate acquired from Apple
    Only supports http download URL
    fairPlayCert.privateEncryptedStringOptionalStringPrivate key acquired upon Fairplay Streaming certificate issuance
    fairPlayCert.secretKeyOptionalStringApplication secret key (ASK) string acquired upon Fairplay Streaming certificate issuance
    statisticsYesObjectStatistics Object
    statistics.siteMontlyActiveUserYesIntegerMAU value created through the site
    statistics.siteMontlyActiveLicenseYesIntegerMAL value created through the site
    statistics.siteMontlyActiveDeviceYesIntegerMAD value created through the site
    siteCreatedTimeYesTimestampSite creation time
    siteUpdatedTimeYesTimestampTime the site is updated

    Examples

    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
    
    {
      "success": true,
      "content": {
        "siteId": "drm-20231120182420-dPTGn",
        "siteName": "myDrmTest2",
        "siteStatus": "READY",
        "siteEnabledYn": false,
        "policyId": 0,
        "policyName": "Basic",
        "statistics": {},
        "siteCreatedTime": 1700472273609,
        "siteUpdatedTime": 1700650420394
      }
    }
    

    Was this article helpful?

    What's Next
    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.