Get Studio DRM Policy Configuration

Retrieves a specific Studio DRM policy configuration.

Request

Request syntax:

GET /drm/policy/[Policy ID](#PolicyID2)

Define the following variable when submitting the above request:

Variable	Description
Policy ID (Required)	Replace this variable with the system-defined ID assigned to the desired Studio DRM policy configuration.

Response

The response for a successful request contains the following parameters:

Name	Data Type	Description
configs	List of dictionaries	Contains the requested Studio DRM policy configuration.
error	Integer	Indicates whether an error occurred. Learn more.

Sample Request/Response

Update the get_studio_drm_pc module to identify the policy that will be retrieved by its system-defined ID.

policy_id = 'abcdef123456ghijkl7890123mno789'

Call the get_studio_drm_pc module (Python 3) to retrieve a specific Studio DRM policy configuration. This module imports names from the api_auth module.

import requests
from api_auth import APICredentials, APIParams

class DRMPolicy:
    def __init__(self):
        self.host = "https://services.uplynk.com"

    def run(self):
        """
        Retrieve a DRM policy.
        """
        self._get_drm_policy()

    def _get_drm_policy(self):
        policy_id = 'abcdef123456ghijkl7890123mno789'
        url = "{}{}{}".format(self.host, "/api/v3/drm/policy/", policy_id)

        response = requests.get(
            url, params=APIParams(APICredentials()).get_params({})
        )

        print(response.json())

DRMPolicy().run()

Response:

{
    'configs': [{
            '_id': 'abcdef123456ghijkl7890123mno789',
            'created': 1558566151978,
            'policy_name': 'My First Policy',
            'fairplay': {
                'key_duration_seconds': 0,
                'hd': {
                    'hdcp_enforcement': -1,
                    'allow_airplay': False,
                    'allow_av_adapter': False
                },
                'persistence_duration_seconds': 0,
                'rental_duration_seconds': 0,
                'lease_duration_seconds': 0,
                'uhd2': {
                    'hdcp_enforcement': -1,
                    'allow_airplay': True,
                    'allow_av_adapter': True
                },
                'uhd1': {
                    'hdcp_enforcement': -1,
                    'allow_airplay': True,
                    'allow_av_adapter': True
                },
                'playback_duration_seconds': 0,
                'sd': {
                    'hdcp_enforcement': -1,
                    'allow_airplay': True,
                    'allow_av_adapter': True
                },
                'rental': False,
                'persistence': False,
                'lease': False
            },
            'lmsig': '1538693547862491_10735_4271',
            'widevine': {
                'content_key_specs': [{
                        'track_type': 'ALL',
                        'security_level': 1,
                        'required_output_protection': {
                            'hdcp_srm_rule': 'HDCP_SRM_RULE_NONE',
                            'hdcp': 'HDCP_NONE',
                            'cgms_flags': 'CGMS_NONE',
                            'disable_analog_output': False
                        }
                    }
                ],
                'policy_overrides': {
                    'renewal_retry_interval_seconds': 0,
                    'can_renew': True,
                    'can_persist': True,
                    'license_duration_seconds': 86400,
                    'always_include_client_id': False,
                    'can_play': True,
                    'rental_duration_seconds': 0,
                    'renewal_delay_seconds': 0,
                    'renewal_recovery_duration_seconds': 0,
                    'playback_duration_seconds': 0,
                    'renew_with_usage': False
                }
            },
            'owner': 'abc33864a92c46a1a286cdd49b0a9123',
            'playready': {
                'license_duration_seconds': 86400,
                'can_persist': False,
                'can_play': True,
                'uhd2': {
                    'digital_video_protection_level': 250,
                    'security_level': 2000,
                    'play_enabler': False,
                    'require_hdcp_type_1': True
                },
                'uhd1': {
                    'digital_video_protection_level': 250,
                    'security_level': 2000,
                    'play_enabler': False,
                    'require_hdcp_type_1': True
                },
                'playback_duration_seconds': 0,
                'hd': {
                    'digital_video_protection_level': 250,
                    'security_level': 2000,
                    'play_enabler': False,
                    'require_hdcp_type_1': True
                },
                'sd': {
                    'require_hdcp_type_1': False,
                    'security_level': 2000,
                    'play_enabler': False,
                    'digital_video_protection_level': 100
                }
            },
            'lastmod': 1558566152020
        }
    ],
    'error': 0
}

configs List

The configs list describes one or more Studio DRM policy configurations using the following parameters:

Name	Data Type	Description
`_id`	String	Identifies a policy by its system-defined ID.
`created`	Integer	Indicates the policy's creation date in Unix time (milliseconds).
`fairplay`	Dictionary	Contains Studio DRM policy settings for Apple FairPlay Streaming.
`lastmod`	Integer	Indicates the policy's last modification date in Unix time (milliseconds).
`lmsig`	String	This parameter is reserved for future use.
`owner`	String	Identifies the CMS user associated with the policy by user ID.
`playready`	Dictionary	Contains Studio DRM policy settings for Microsoft PlayReady.
`policy_name`	String	Identifies a policy by its name.
`widevine`	Dictionary	Contains Studio DRM policy settings for Google Widevine DRM.

Apple FairPlay Streaming

The fairplay dictionary describes Apple FairPlay Streaming DRM policies.

Name	Data Type	Description
`hd`	Dictionary	Contains the DRM policy for high definition (720p and 1080p) tracks.
`key_duration_seconds`	Integer	Determines the length of time, in seconds, for which the Content Key will be valid. Default value: `0`
`lease`	Boolean	Determines whether a client may renew a lease. Playback is only allowed while the lease is valid. Default value: `False`
`lease_duration_seconds`	Integer	Determines the length of time, in seconds, during which playback will be allowed. Playback will stop upon the expiration of the lease. Default value: `0`
`persistence`	Boolean	Determines whether offline playback is allowed. Default value: `False`
`persistence_duration_seconds`	Integer	Determines the length of time, in seconds, during which offline playback is allowed. Default value: `0`
`playback_duration_seconds`	Integer	Determines the length of time, in seconds, for which playback will be valid. Default value: `0`
`rental`	Boolean	Determines whether offline rental is allowed. Default value: `False`
`rental_duration_seconds`	Integer	Determines the length of time, in seconds, during which the Content Key is valid prior to initial playback. Default value: `0`
`sd`	Dictionary	Contains the DRM policy for standard definition (576p or less) tracks.
`uhd1`	Dictionary	Contains the DRM policy for 4K ultra-high-definition video tracks.
`uhd2`	Dictionary	Contains the DRM policy for 8K ultra-high-definition video tracks.

Resolution Dictionary

Each of the above dictionaries contains the following parameters that describe the Apple FairPlay Streaming DRM policy for that resolution:

Name	Data Type	Description
`allow_airplay`	Boolean	Determines whether playback will be allowed over AirPlay. Default value: `True`
`allow_av_adapter`	Boolean	Determines whether playback may be mirrored via an Apple Lightning AV Adapter. Default value: `True`
`hdcp_enforcement`	Integer	Determines whether High-bandwidth Digital Content Protection (HDCP) enforcement is required. Default value: `-1`

Google Widevine DRM

The widevine dictionary contains the following parameters that describe a Google Widevine DRM policy:

Name	Data Type	Description
`content_key_specs`	List of dictionaries	Determines which content keys should be returned. This parameter must be specified for all tracks and should be used to define a policy when a pre-existing one has not been associated with the content. Default content key policy: `[{'track_type': 'ALL', 'required_output_protection': {'hdcp_srm_rule': 'HDCP_SRM_RULE_NONE', 'hdcp': 'HDCP_NONE', 'cgms_flags': 'CGMS_NONE', 'disable_analog_output': False }, 'security_level': 1 }]`
`policy_overrides`	Dictionary	Determines the policy for the current license. The specified policy will override one assigned directly to an asset. Default policy overrides: `{ 'can_renew': False, 'renewal_retry_interval_seconds': 0, 'always_include_client_id': False, 'license_duration_seconds': 86400, 'can_persist': False, 'can_play': True, 'rental_duration_seconds': 0, 'renewal_delay_seconds': 0, 'renewal_recovery_duration_seconds': 0, 'playback_duration_seconds': 0, 'renew_with_usage': False }`

`policy_overrides` Dictionary

The policy_overrides dictionary defines the Studio DRM policy that will be used instead of policies assigned directly to an asset.

Name	Data Type	Description
`always_include_client_id`	Boolean	Reserved for future use.
`can_persist`	Boolean	Determines whether offline playback is allowed. Default: `False`.
`can_play`	Boolean	Determines whether playback is allowed. Required. Default: `True`.
`can_renew`	Boolean	Reserved for future use.
`license_duration_seconds`	Integer	Determines the length of time (in seconds) that content playback is allowed. Default: `86400`.
`playback_duration_seconds`	Integer	Defines how long a license is valid after its initial use. Used for offline or license renewal scenarios. Default: `0`.
`renew_with_usage`	Boolean	Reserved for future use.
`renewal_delay_seconds`	Integer	Reserved for future use.
`renewal_recovery_duration_seconds`	Integer	Reserved for future use.
`renewal_retry_interval_seconds`	Integer	Reserved for future use.
`renewal_server_url`	String	Reserved for future use.
`rental_duration_seconds`	Integer	Determines how long a license remains valid before its initial use. Default: `0`.

`content_key_specs` List

The content_key_specs list defines Studio DRM policy on a per-track basis.

Name	Data Type	Description
`required_output_protection`	Dictionary	Contains key-value pairs defining protection requirements for the output. The values are case-sensitive.
`security_level`	Integer	Determines the minimum security level for cryptography, content decoding, and media operations. Default: `1`.
`track_type`	String	Defines the scope of the policy by track type. Default: `ALL`.

Microsoft PlayReady

The playready dictionary describes resolution-specific Microsoft PlayReady DRM policies.

Name	Data Type	Description
`can_persist`	Boolean	Determines whether offline playback is allowed. Default: `False`.
`can_play`	Boolean	Determines whether playback is allowed. Default: `True`.
`hd`	Dictionary	Contains the DRM policy for high-definition (720p and 1080p) tracks.
`license_duration_seconds`	Integer	Determines how long content playback is allowed before expiration. Default: `86400`.
`playback_duration_seconds`	Integer	Defines the time (in seconds) for which playback will be valid after initial playback. Default: `0`.
`realtime_expiration`	Boolean	Determines whether the current playback session stops upon license expiration. Default: `True`.
`sd`	Dictionary	Contains the DRM policy for standard definition (576p or less) tracks.
`uhd1`	Dictionary	Contains the DRM policy for 4K ultra-high-definition video tracks.
`uhd2`	Dictionary	Contains the DRM policy for 8K ultra-high-definition video tracks.

Resolution Dictionary

Each of these dictionaries contains parameters describing the Microsoft PlayReady DRM policy for that resolution.

Name	Data Type	Description
`analog_video_protection_level`	Integer	Defines minimum security requirements for analog video outputs. Default: `100`.
`compressed_digital_audio_protection_level`	Integer	Defines security requirements for passing compressed digital audio. Default: `100`.
`digital_video_protection_level`	Integer	Determines digital video protection level. Default: `100`.
`play_enabler`	Boolean	Determines if playback is allowed on a VM (for testing only). Default: `False`.
`require_hdcp_type_1`	Boolean	Enforces HDCP content type 1 (HDCP 2.2 or later). Default: `False`.
`security_level`	Integer	Defines the minimum security requirement for client devices. Default: `2000`.
`uncompressed_digital_audio_protection_level`	Integer	Defines security for uncompressed digital audio output. Default: `100`.

Default Policy

Policy settings that are not explicitly set are defined according to the following default Studio DRM policy:

{
    "fairplay": {
        "key_duration_seconds": 0,
        "hd": {
            "hdcp_enforcement": -1,
            "allow_airplay": true,
            "allow_av_adapter": true
        },
        "persistence_duration_seconds": 0,
        "rental_duration_seconds": 0,
        "lease_duration_seconds": 0,
        "uhd2": {
            "hdcp_enforcement": -1,
            "allow_airplay": true,
            "allow_av_adapter": true
        },
        "uhd1": {
            "hdcp_enforcement": -1,
            "allow_airplay": true,
            "allow_av_adapter": true
        },
        "playback_duration_seconds": 0,
        "sd": {
            "hdcp_enforcement": -1,
            "allow_airplay": true,
            "allow_av_adapter": true
        }
    },
    "widevine": {
        "content_key_specs": [{
                "track_type": "ALL",
                "required_output_protection": {
                    "hdcp_srm_rule": "HDCP_SRM_RULE_NONE",
                    "hdcp": "HDCP_NONE",
                    "cgms_flags": "CGMS_NONE",
                    "disable_analog_output": false
                },
                "security_level": 1
            }
        ],
        "policy_overrides": {
            "can_renew": false,
            "renewal_retry_interval_seconds": 0,
            "always_include_client_id": false,
            "license_duration_seconds": 86400,
            "can_persist": false,
            "can_play": true,
            "rental_duration_seconds": 0,
            "renewal_delay_seconds": 0,
            "renewal_recovery_duration_seconds": 0,
            "playback_duration_seconds": 0,
            "renew_with_usage": false
        }
    },
    "playready": {
        "license_duration_seconds": 86400,
        "can_persist": false,
        "realtime_expiration": true,
        "can_play": true,
        "uhd2": {
            "require_hdcp_type_1": false,
            "security_level": 2000,
            "play_enabler": false,
            "analog_video_protection_level": 100,
            "compressed_digital_audio_protection_level": 100,
            "uncompressed_digital_audio_protection_level": 100,
            "digital_video_protection_level": 100
        },
        "uhd1": {
            "require_hdcp_type_1": false,
            "security_level": 2000,
            "play_enabler": false,
            "analog_video_protection_level": 100,
            "compressed_digital_audio_protection_level": 100,
            "uncompressed_digital_audio_protection_level": 100,
            "digital_video_protection_level": 100
        },
        "playback_duration_seconds": 0,
        "hd": {
            "require_hdcp_type_1": false,
            "security_level": 2000,
            "play_enabler": false,
            "analog_video_protection_level": 100,
            "compressed_digital_audio_protection_level": 100,
            "uncompressed_digital_audio_protection_level": 100,
            "digital_video_protection_level": 100
        },
        "sd": {
            "require_hdcp_type_1": false,
            "security_level": 2000,
            "play_enabler": false,
            "analog_video_protection_level": 100,
            "compressed_digital_audio_protection_level": 100,
            "uncompressed_digital_audio_protection_level": 100,
            "digital_video_protection_level": 100
        }
    }
}

Request

Response

Sample Request/Response

configs List

Apple FairPlay Streaming

Resolution Dictionary

Google Widevine DRM

policy_overrides Dictionary

content_key_specs List

Microsoft PlayReady

Resolution Dictionary

Default Policy

`policy_overrides` Dictionary

`content_key_specs` List