View site list
- Print
- PDF
View site list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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}
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| pageNo | No | Integer | No restriction | Page index to view |
| pageSizeNo | No | Integer | 1-100 | Number 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 name | Requirement status | Description |
|---|---|---|
| x-ncp-apigw-timestamp | YES | This 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-key | YES | Value of access key ID issued in the NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
| x-ncp-apigw-signature-v2 | YES | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | YES | Specifies the request body content type as application/jsonContent-Type: application/json |
| x-ncp-region_code | YES | Region code (KR) |
Response
| Field name | Requirement status | Type | Restriction | Description |
|---|---|---|---|---|
| siteName | Yes | String | This must be between 3 and 20 characters in length Special character (underscore) allowed | Name of the site to be created |
| siteId | Yes | String | Unique ID of the created site | |
| siteStatus | Yes | String | CREATING,READY,RUNNING,DELETED | Condition of the created site |
| siteEnabledYn | Yes | Boolean | Site activation status | |
| policyId | Yes | Integer | default policyId : 0 | Playback and security policy according to DRM type used during DRM application |
| policyName | Yes | String | default policyName : BASIC | |
| fairPlayCert | Optional | Object | Fairplay certification for FairPlay Streaming DRM application | |
| fairPlayCert.certFile | Optional | String | Only supports *.der or *.cer file | FairPlay Streaming certificate acquired from Apple Only supports http download URL |
| fairPlayCert.privateKey | Optional | String | Only supports *.pem files | Private key file of the FairPlay Streaming certificate acquired from Apple Only supports http download URL |
| fairPlayCert.privateEncryptedString | Optional | String | Private key acquired upon Fairplay Streaming certificate issuance | |
| fairPlayCert.secretKey | Optional | String | Application secret key (ASK) string acquired upon Fairplay Streaming certificate issuance | |
| statistics | Yes | Object | Statistics Object | |
| statistics.siteMontlyActiveUser | Yes | Integer | MAU value created through the site | |
| statistics.siteMontlyActiveLicense | Yes | Integer | MAL value created through the site | |
| statistics.siteMontlyActiveDevice | Yes | Integer | MAD value created through the site | |
| siteCreatedTime | Yes | Timestamp | Site 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
},
....
}
Was this article helpful?