|
| 1 | +# mux_python.DRMConfigurationsApi |
| 2 | + |
| 3 | +All URIs are relative to *https://api.mux.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**get_drm_configuration**](DRMConfigurationsApi.md#get_drm_configuration) | **GET** /video/v1/drm-configurations/{DRM_CONFIGURATION_ID} | Retrieve a DRM Configuration |
| 8 | +[**list_drm_configurations**](DRMConfigurationsApi.md#list_drm_configurations) | **GET** /video/v1/drm-configurations | List DRM Configurations |
| 9 | + |
| 10 | + |
| 11 | +# **get_drm_configuration** |
| 12 | +> DRMConfigurationResponse get_drm_configuration(drm_configuration_id) |
| 13 | +
|
| 14 | +Retrieve a DRM Configuration |
| 15 | + |
| 16 | +Retrieves a single DRM Configuration. |
| 17 | + |
| 18 | +### Example |
| 19 | + |
| 20 | +* Basic Authentication (accessToken): |
| 21 | +```python |
| 22 | +from __future__ import print_function |
| 23 | +import time |
| 24 | +import mux_python |
| 25 | +from mux_python.rest import ApiException |
| 26 | +from pprint import pprint |
| 27 | +# Defining the host is optional and defaults to https://api.mux.com |
| 28 | +# See configuration.py for a list of all supported configuration parameters. |
| 29 | +configuration = mux_python.Configuration( |
| 30 | + host = "https://api.mux.com" |
| 31 | +) |
| 32 | + |
| 33 | +# The client must configure the authentication and authorization parameters |
| 34 | +# in accordance with the API server security policy. |
| 35 | +# Examples for each auth method are provided below, use the example that |
| 36 | +# satisfies your auth use case. |
| 37 | + |
| 38 | +# Configure HTTP basic authorization: accessToken |
| 39 | +configuration = mux_python.Configuration( |
| 40 | + username = 'YOUR_USERNAME', |
| 41 | + password = 'YOUR_PASSWORD' |
| 42 | +) |
| 43 | + |
| 44 | +# Enter a context with an instance of the API client |
| 45 | +with mux_python.ApiClient(configuration) as api_client: |
| 46 | + # Create an instance of the API class |
| 47 | + api_instance = mux_python.DRMConfigurationsApi(api_client) |
| 48 | + drm_configuration_id = 'drm_configuration_id_example' # str | The DRM Configuration ID. |
| 49 | + |
| 50 | + try: |
| 51 | + # Retrieve a DRM Configuration |
| 52 | + api_response = api_instance.get_drm_configuration(drm_configuration_id) |
| 53 | + pprint(api_response) |
| 54 | + except ApiException as e: |
| 55 | + print("Exception when calling DRMConfigurationsApi->get_drm_configuration: %s\n" % e) |
| 56 | +``` |
| 57 | + |
| 58 | +### Parameters |
| 59 | + |
| 60 | +Name | Type | Description | Notes |
| 61 | +------------- | ------------- | ------------- | ------------- |
| 62 | + **drm_configuration_id** | **str**| The DRM Configuration ID. | |
| 63 | + |
| 64 | +### Return type |
| 65 | + |
| 66 | +[**DRMConfigurationResponse**](DRMConfigurationResponse.md) |
| 67 | + |
| 68 | +### Authorization |
| 69 | + |
| 70 | +[accessToken](../README.md#accessToken) |
| 71 | + |
| 72 | +### HTTP request headers |
| 73 | + |
| 74 | + - **Content-Type**: Not defined |
| 75 | + - **Accept**: application/json |
| 76 | + |
| 77 | +### HTTP response details |
| 78 | +| Status code | Description | Response headers | |
| 79 | +|-------------|-------------|------------------| |
| 80 | +**200** | OK | - | |
| 81 | + |
| 82 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 83 | + |
| 84 | +# **list_drm_configurations** |
| 85 | +> ListDRMConfigurationsResponse list_drm_configurations(page=page, limit=limit) |
| 86 | +
|
| 87 | +List DRM Configurations |
| 88 | + |
| 89 | +Returns a list of DRM Configurations |
| 90 | + |
| 91 | +### Example |
| 92 | + |
| 93 | +* Basic Authentication (accessToken): |
| 94 | +```python |
| 95 | +from __future__ import print_function |
| 96 | +import time |
| 97 | +import mux_python |
| 98 | +from mux_python.rest import ApiException |
| 99 | +from pprint import pprint |
| 100 | +# Defining the host is optional and defaults to https://api.mux.com |
| 101 | +# See configuration.py for a list of all supported configuration parameters. |
| 102 | +configuration = mux_python.Configuration( |
| 103 | + host = "https://api.mux.com" |
| 104 | +) |
| 105 | + |
| 106 | +# The client must configure the authentication and authorization parameters |
| 107 | +# in accordance with the API server security policy. |
| 108 | +# Examples for each auth method are provided below, use the example that |
| 109 | +# satisfies your auth use case. |
| 110 | + |
| 111 | +# Configure HTTP basic authorization: accessToken |
| 112 | +configuration = mux_python.Configuration( |
| 113 | + username = 'YOUR_USERNAME', |
| 114 | + password = 'YOUR_PASSWORD' |
| 115 | +) |
| 116 | + |
| 117 | +# Enter a context with an instance of the API client |
| 118 | +with mux_python.ApiClient(configuration) as api_client: |
| 119 | + # Create an instance of the API class |
| 120 | + api_instance = mux_python.DRMConfigurationsApi(api_client) |
| 121 | + page = 1 # int | Offset by this many pages, of the size of `limit` (optional) (default to 1) |
| 122 | +limit = 25 # int | Number of items to include in the response (optional) (default to 25) |
| 123 | + |
| 124 | + try: |
| 125 | + # List DRM Configurations |
| 126 | + api_response = api_instance.list_drm_configurations(page=page, limit=limit) |
| 127 | + pprint(api_response) |
| 128 | + except ApiException as e: |
| 129 | + print("Exception when calling DRMConfigurationsApi->list_drm_configurations: %s\n" % e) |
| 130 | +``` |
| 131 | + |
| 132 | +### Parameters |
| 133 | + |
| 134 | +Name | Type | Description | Notes |
| 135 | +------------- | ------------- | ------------- | ------------- |
| 136 | + **page** | **int**| Offset by this many pages, of the size of `limit` | [optional] [default to 1] |
| 137 | + **limit** | **int**| Number of items to include in the response | [optional] [default to 25] |
| 138 | + |
| 139 | +### Return type |
| 140 | + |
| 141 | +[**ListDRMConfigurationsResponse**](ListDRMConfigurationsResponse.md) |
| 142 | + |
| 143 | +### Authorization |
| 144 | + |
| 145 | +[accessToken](../README.md#accessToken) |
| 146 | + |
| 147 | +### HTTP request headers |
| 148 | + |
| 149 | + - **Content-Type**: Not defined |
| 150 | + - **Accept**: application/json |
| 151 | + |
| 152 | +### HTTP response details |
| 153 | +| Status code | Description | Response headers | |
| 154 | +|-------------|-------------|------------------| |
| 155 | +**200** | OK | - | |
| 156 | + |
| 157 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 158 | + |
0 commit comments