MENU
      View site list
        • PDF

        View site list

        • PDF

        Article summary

        One Click Multi DRM provides an API to view the list of created sites.

        Requests

        GET https://multi-drm.apigw.ntruss.com/api/v1/sites?pageNo={pageNo}&pageSizeNo={pageSizeNo}
        HTTP

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        pageNoNoIntegerNo restrictionPage index to view
        pageSizeNoNoInteger1-100Number of sites to include when viewing lists
        For example, when 60 sites are created with pageSizeNo 30, the viewing of site list is done in 30 sites per page

        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)

        Response

        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
        siteStatusYesStringCREATING,READY,RUNNING,DELETEDCondition of the created site
        siteEnabledYnYesBooleanSite activation status
        policyIdYesIntegerdefault policyId : 0Playback and security policy according to DRM type used during DRM application
        policyNameYesStringdefault policyName : BASIC
        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

        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": [
              {
              "id": "drm-20231101082809-aqvlM",
              "siteName": "myMultiDrm01",
              "siteStatus": "READY",
              "siteEnabledYn": true,
              "policyId": 0,
              "policyName": "Basic",
              "fairPlayCert": {},
              "statistics": {
                "siteMontlyActiveUser": 0,
                "siteMontlyActiveDevice": 0,
                "siteMontlyActiveLicense": 0
              },
              "siteCreatedTime": 1696817889000
            },
            {
              "id": "drm-20231101082809-eqhlV",
              "siteName": "myMultiDrm02",
              "siteStatus": "RUNNING",
              "siteEnabledYn": true,
              "policyId": 0,
              "policyName": "Basic",
              "fairPlayCert": {},
              "statistics": {
                "siteMontlyActiveUser": 0,
                "siteMontlyActiveDevice": 0,
                "siteMontlyActiveLicense": 0
              },
              "siteCreatedTime": 1696817889000
            },
            {
              "id": "drm-20231101082812-BUnMJ",
              "siteName": "myMultiDrm03",
              "siteStatus": "READY",
              "siteEnabledYn": false,
              "policyId": 0,
              "policyName": "Basic",
              "fairPlayCert": {},
              "statistics": {
                "siteMontlyActiveUser": 0,
                "siteMontlyActiveDevice": 0,
                "siteMontlyActiveLicense": 0
              },
              "siteCreatedTime": 1696817889000
            },
        ....
        }
        HTTP

        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.