Create DRM System

POST

https://device.example.com/cluster1/vos-api/scrambling/v1/drm/systems

POST

/cluster1/vos-api/scrambling/v1/drm/systems

curl -X POST https://device.example.com/cluster1/vos-api/scrambling/v1/drm/systems \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "encryptionInterfaceType": "e_HKMS_MIN",
  "id": "string",
  "keyManagementServers": [
    {
      "httpsCertValidation": true,
      "rank": 1,
      "url": "string"
    }
  ],
  "name": "string",
  "requestorId": "string"
}'

{
  "encryptionInterfaceType": "e_HKMS_MIN",
  "id": "string",
  "keyManagementServers": [
    {
      "httpsCertValidation": true,
      "rank": 1,
      "url": "string"
    }
  ],
  "name": "string",
  "requestorId": "string",
  "cpixDocumentVersion": "e_2_2",
  "customHeader": {
    "fieldName": "string",
    "fieldValue": "string"
  },
  "drmGroups": [
    {
      "drms": [
        "string"
      ],
      "id": "string",
      "name": "string",
      "packagingType": "e_HLS"
    }
  ],
  "embeddedDrmTrackFilters": [
    {
      "drmTrackFilterProfileProperties": {
        "drmTrackFilterProperties": [
          {
            "name": "string",
            "trackType": "string",
            "audioStreamSelections": [
              {
                "audioCodecSelection": "AAC_LC",
                "audioLanguageSelections": [
                  "string"
                ],
                "bitrateRange": {
                  "maxBitrateInbps": 1,
                  "minBitrateInbps": 1
                },
                "withAudioGain": "ENABLE"
              }
            ],
            "clearOutput": true,
            "videoStreamSelections": [
              {
                "bitrateRange": {
                  "esBitrateRange": {
                    "maxBitrateInbps": 1,
                    "minBitrateInbps": 1
                  },
                  "exclude": true,
                  "maxBitrateInbps": 1,
                  "minBitrateInbps": 1,
                  "tsBitrateRange": {
                    "maxBitrateInbps": 1,
                    "minBitrateInbps": 1
                  }
                },
                "frameRateRange": {
                  "maxFrameRate": 1,
                  "minFrameRate": 1
                },
                "horizontalResolutionRange": {
                  "maxHorizaontalResolution": 1,
                  "maxHorizontalResolution": 1,
                  "minHorizaontalResolution": 1,
                  "minHorizontalResolution": 1
                },
                "verticalResolutionRange": {
                  "maxVerticalResolution": 1,
                  "minVerticalResolution": 1
                },
                "videoCodecSelection": "H_265"
              }
            ]
          }
        ],
        "name": "string"
      },
      "id": "string",
      "name": "string"
    }
  ],
  "enforceKeyEncryptionValidation": true,
  "httpMethod": "POST",
  "insertContentKeyPeriodIndex": true,
  "insertDeliveryKeyCertificate": true,
  "insertDrmSystemIdInRequest": true,
  "keyDefaultValue": "string",
  "keyRequestSign": true,
  "keyResponsesSignatureValidate": true,
  "keyRotationSettings": {
    "controller": "KMS",
    "mode": "INDEX",
    "numberOfKeyPeriods": 1,
    "preFetchRequestRelativeTime": 1
  },
  "kmsRequestHlsTsCommonEncryptionScheme": "NONE",
  "resources": [
    {
      "id": "string",
      "name": "string",
      "packagingType": "e_HLS",
      "resourceId": "string",
      "drmTrackFilterId": "string",
      "widevineCustomContentProtection": "string"
    }
  ],
  "useProxy": true,
  "widevineConfig": {
    "signer": "string",
    "signingIv": "string",
    "signingKey": "string"
  }
}

Create a DRM system for OTT encryption.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

drmSystem

encryptionInterfaceTypeenumRequired

Encryption Intreface Type

idstringRequired

ID of DRM System

keyManagementServerslist of objectsRequired

Key Management Servers

namestringRequired

Name of DRM System

requestorIdstringRequired

Requestor Id

cpixDocumentVersionenumOptional

CPIX document version

Allowed values:

customHeaderobjectOptional

drmGroupslist of objectsOptional

List of DRM Group

embeddedDrmTrackFilterslist of objectsOptional

Embedded DRM filtering profile properties. It is required in NMS configuration

enforceKeyEncryptionValidationbooleanOptional

Boolean value to verify that the key from the Harmonic CPIX response is encrypted

httpMethodenumOptional

Option to use GET HTTP method for requesting DRM metadata

Allowed values:

insertContentKeyPeriodIndexbooleanOptional

Boolean to force inserting of ContentKeyPeriod@Index into Harmonic CPIX request when key rotation is disabled (for backward compatibility purpose only)

insertDeliveryKeyCertificatebooleanOptional

Boolean to control inserting of DeliveryKeyCertificate into Harmonic CPIX request

insertDrmSystemIdInRequestbooleanOptional

Boolean to control inserting DRM system ID or not during key retrieval

keyDefaultValuestringOptional

keyRequestSignbooleanOptional

Enabling / disabling digital signature of key requests

keyResponsesSignatureValidatebooleanOptional

Enabling / disabling the validation of key responses signature

keyRotationSettingsobjectOptional

kmsRequestHlsTsCommonEncryptionSchemeenumOptional

Common Encryption Scheme for HLS-sTS

Allowed values:

resourceslist of objectsOptional

Resources

useProxybooleanOptional

Boolean value to use / not use Proxy endpoints

widevineConfigobjectOptional

Response

encryptionInterfaceTypeenum

Encryption Intreface Type

idstring

ID of DRM System

keyManagementServerslist of objects

Key Management Servers

namestring

Name of DRM System

requestorIdstring

Requestor Id

cpixDocumentVersionenumOptional

CPIX document version

Allowed values:

customHeaderobjectOptional

drmGroupslist of objectsOptional

List of DRM Group

embeddedDrmTrackFilterslist of objectsOptional

Embedded DRM filtering profile properties. It is required in NMS configuration

enforceKeyEncryptionValidationbooleanOptional

Boolean value to verify that the key from the Harmonic CPIX response is encrypted

httpMethodenumOptional

Option to use GET HTTP method for requesting DRM metadata

Allowed values:

insertContentKeyPeriodIndexbooleanOptional

Boolean to force inserting of ContentKeyPeriod@Index into Harmonic CPIX request when key rotation is disabled (for backward compatibility purpose only)

insertDeliveryKeyCertificatebooleanOptional

Boolean to control inserting of DeliveryKeyCertificate into Harmonic CPIX request

insertDrmSystemIdInRequestbooleanOptional

Boolean to control inserting DRM system ID or not during key retrieval

keyDefaultValuestringOptional

keyRequestSignbooleanOptional

Enabling / disabling digital signature of key requests

keyResponsesSignatureValidatebooleanOptional

Enabling / disabling the validation of key responses signature

keyRotationSettingsobjectOptional

kmsRequestHlsTsCommonEncryptionSchemeenumOptional

Common Encryption Scheme for HLS-sTS

Allowed values:

resourceslist of objectsOptional

Resources

useProxybooleanOptional

Boolean value to use / not use Proxy endpoints

widevineConfigobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error