> This page is for mk.io. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server. # List Streaming Policies GET https://app.mk.io/api/v1/projects/{project_name}/media/streamingPolicies ## Listing, Sorting and Filtering Streaming Policies This endpoint returns the list of streaming policies in the specified project. ### Sorting The results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas where each one can optionally specify `asc` or `desc`. Sorting is valid on the following fields: `created`, `createdBy`, `id`, `name`, `properties/created`, `updated`, `updatedBy` ### Filtering The `$filter` query parameter allows for streaming policies to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `created`, `createdBy`, `createdByEmail`, `createdByName`, `id`, `name`, `properties/created`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName` ### Examples: `?$top=10` - Returns only the first 10 streaming policies from the list. `?$orderby=name desc` - Sorts streaming policies by name in descending order. `?$filter=name eq 'descriptive name'` - Returns streaming policies that match the provided name. `?$orderby=created desc` - Sorts streaming policies by creation date in descending order. `?$filter=created ge 2021-01-01T00:00:00Z` - Returns streaming policies created after January 1, 2021. ## Note that the default policies will always appear in the results RBAC Capability Required: `ams.streamingpolicy.get` Reference: https://mediakind.ferndocs.com/mkio/api/media/streaming-policies/list-streaming-policies ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `project_name` (string, required) ### Query parameters - `$orderby` (string, optional) — Specifies the key by which the result collection should be ordered. - `$filter` (string, optional) — Restricts the set of items returned. - `$top` (string, optional) — Specifies a non-negative integer `n` that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value `n`. - `$skiptoken` (string, optional) — Specifies a start offset to support paginated results. Use `@odata.nextLink` in the result object to enumerate the collection - it will be present only if there's more than one page of entities. ## Response ### 200 A list of streaming policies. - `supplemental` (ListResponseSupplementalSchema, required) — Supplemental info - `value` (list of StreamingPolicySchema, required) — A list of streaming policies. - `@odata.nextLink` (string, optional) — @odata.nextLink URL if the page length and number of items match. ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 401 Unauthorized Error Unauthorized - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 403 Forbidden Error Forbidden - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 404 Not Found Error Not Found - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 429 Too Many Requests Error Too Many Requests - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 500 Internal Server Error Internal Server Error - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ## Types ### ListResponseSupplementalSchema - `count` (integer, required) — Number of items returned - `kind` (string, required) — Type of items in the list - `operation` (string, required) — Operation type. Should always say 'list' - `pagination` (PaginationInfoSchema, required) — Pagination info - `subscription` (ProjectInfoSchema, optional) — Project info ### StreamingPolicySchema - `properties` (StreamingPolicyProperties, required) — The properties of the streaming policy. - `id` (string, optional) — Fully qualified resource ID for the resource. Ex - /subscriptions/\{subscriptionId}/resourceGroups/\{resourceGroupName}/providers/\{resourceProviderNamespace}/\{resourceType}/\{resourceName} - `name` (string, optional) — The name of the resource - `systemData` (SystemDataSchema, optional) — Metadata pertaining to creation and last modification of the resource. - `type` (string, optional) — The type of the resource. E.g. "Microsoft.Media/mediaservices/assets" ### ErrorDetail - `code` (string, required) — The error code. - `detail` (string, required) — The error message. - `extraDetail` (map from string to any, optional) — Extra information regarding this error. ### PaginationInfoSchema - `end` (integer, required) — Position of the last item in the list - `records` (integer, required) — Total number of items returned in the list - `start` (integer, required) — Position of the first item in the list - `total` (integer, required) — Total number of items in the project ### ProjectInfoSchema - `id` (string, required) — Project ID - `name` (string, required) — Project name ### StreamingPolicyProperties - `catalog` (map from string to any, optional) — The custom catalog configuration. - `commonEncryptionCbcs` (CommonEncryptionCbcs, optional) — CommonEncryptionCbcs - `commonEncryptionCenc` (CommonEncryptionCenc, optional) — CommonEncryptionCenc - `defaultContentKeyPolicyName` (string, optional) — The default content key policy name used by current streaming policy. - `envelopeEncryption` (EnvelopeEncryption, optional) — EnvelopeEncryption - `noEncryption` (NoEncryption, optional) — NoEncryption ### SystemDataSchema - `createdAt` (datetime, required) — The timestamp of resource creation (UTC). - `createdBy` (string, required) — The identity that created the resource. - `createdByType` (enum, required) — The type of identity that created the resource. - Allowed values: `User`, `Application`, `ManagedIdentity`, `Key` - `internalId` (string, required) — The internal ID of the resource. - `lastModifiedAt` (datetime, required) — The timestamp of resource last modification (UTC). - `lastModifiedBy` (string, required) — The identity that last modified the resource. - `lastModifiedByType` (enum, required) — The type of identity that last modified the resource. - Allowed values: `User`, `Application`, `ManagedIdentity`, `Key` ### CommonEncryptionCbcs - `clearKeyEncryptionConfiguration` (ClearKeyEncryptionConfiguration, optional) — Clear key configuration - `clearTracks` (list of StreamingPolicyTrackSelection, optional) — This represents which tracks should *not* be encrypted. - `contentKeys` (StreamingPolicyContentKeys, optional) — Content keys used by the streaming policy. - `drm` (CbcsDrmConfiguration, optional) — DRM configuration - `enabledProtocols` (EnabledProtocols, optional) — Enabled protocols. This is the set of protocols (dash, download, and hls) that will be delivered with common encryption. ### CommonEncryptionCenc - `clearKeyEncryptionConfiguration` (ClearKeyEncryptionConfiguration, optional) — Clear key configuration - `clearTracks` (list of StreamingPolicyTrackSelection, optional) — This represents which tracks should *not* be encrypted. - `contentKeys` (StreamingPolicyContentKeys, optional) — Content keys used by the streaming policy. - `drm` (CencDrmConfiguration, optional) — DRM configuration - `enabledProtocols` (EnabledProtocols, optional) — Enabled protocols. This is the set of protocols (dash, download, and hls) that will be delivered with common encryption. ### EnvelopeEncryption - `clearTracks` (list of StreamingPolicyTrackSelection, optional) — Clear tracks. This is the set of tracks that will be delivered without envelope encryption. - `contentKeys` (StreamingPolicyContentKeys, optional) — Content keys used by the streaming policy. - `customKeyAcquisitionUrlTemplate` (string, optional) — Optional template for the customer service to use for key acquisition. Not needed if using the built-in key delivery service. - `enabledProtocols` (EnabledProtocols, optional) — Enabled protocols. This is the set of protocols (dash, download, and hls) that will be delivered with envelope encryption. ### NoEncryption - `enabledProtocols` (EnabledProtocols, optional) — Enabled protocols. This is the set of protocols (dash, download, and hls) that will be delivered without encryption. ### ClearKeyEncryptionConfiguration - `customKeysAcquisitionUrlTemplate` (string, optional) — The custom license acquisition URL template for a Clear Key license delivery service. ### StreamingPolicyTrackSelection - `trackSelections` (list of StreamingPolicyTrackPropertyCondition, optional) — track selections is used to specify a set or a subset of track for selection by the streaming policy. ### StreamingPolicyContentKeys - `defaultKey` (DefaultKey, optional) — Default content key used by the encryption. - `keyToTrackMappings` (list of StreamingPolicyContentKey, optional) — List of content keys used by the key. Used to assign different keys to different tracks. For instance, using widevine L3 for SD and L1 for HD. ### CbcsDrmConfiguration - `fairPlay` (StreamingPolicyFairPlayConfiguration, optional) — FairPlay configuration - `playReady` (StreamingPolicyPlayReadyConfiguration, optional) — PlayReady configuration - `widevine` (StreamingPolicyWidevineConfiguration, optional) — Widevine configuration ### EnabledProtocols - `dash` (boolean, required) — Enable Dash protocol - `download` (boolean, required) — Enable download protocol - `hls` (boolean, required) — Enable HLS protocol - `smoothStreaming` (boolean, required) — Smooth streaming is not supported and the value of this field is ignored. ### CencDrmConfiguration - `playReady` (StreamingPolicyPlayReadyConfiguration, optional) — PlayReady configuration - `widevine` (StreamingPolicyWidevineConfiguration, optional) — Widevine configuration ### StreamingPolicyTrackPropertyCondition - `operation` (enum, required) — Track property operation. Only equality is supported. - Allowed values: `Unknown`, `Equal` - `property` (enum, required) — Track property type - Allowed values: `Unknown`, `FourCC` - `value` (string, optional) — Track property value ### DefaultKey - `label` (string, optional) — Labels are a potential matching field for selecting a content key via a streaming locator. - `policyName` (string, optional) — Policy used by the key. ### StreamingPolicyContentKey - `label` (string, optional) — Labels are a potential matching field for selecting a content key via a streaming locator. - `policyName` (string, optional) — Policy used by the key. - `tracks` (list of StreamingPolicyTrackSelection, optional) — This represents which tracks should be encrypted. ### StreamingPolicyFairPlayConfiguration - `allowPersistentLicense` (boolean, required) — Allow persistent license - `customLicenseAcquisitionUrlTemplate` (string, optional) — The custom license acquisition URL template for a FairPlay license delivery service. ### StreamingPolicyPlayReadyConfiguration - `customLicenseAcquisitionUrlTemplate` (string, optional) — The custom license acquisition URL template for a PlayReady license delivery service. - `playReadyCustomAttributes` (string, optional) — The custom attributes for PlayReady. ### StreamingPolicyWidevineConfiguration - `customLicenseAcquisitionUrlTemplate` (string, optional) — The custom license acquisition URL template for a Widevine license delivery service. ## Examples **Response** ```json { "supplemental": { "count": 1, "kind": "string", "operation": "string", "pagination": { "end": 1, "records": 1, "start": 1, "total": 1 }, "subscription": { "id": "string", "name": "string" } }, "value": [ { "properties": { "catalog": {}, "commonEncryptionCbcs": { "clearKeyEncryptionConfiguration": { "customKeysAcquisitionUrlTemplate": "string" }, "clearTracks": [ { "trackSelections": [ { "operation": "Unknown", "property": "Unknown", "value": "string" } ] } ], "contentKeys": { "defaultKey": { "label": "string", "policyName": "string" }, "keyToTrackMappings": [ { "label": "string", "policyName": "string", "tracks": [ { "trackSelections": [ { "operation": "Unknown", "property": "Unknown", "value": "string" } ] } ] } ] }, "drm": { "fairPlay": { "allowPersistentLicense": true, "customLicenseAcquisitionUrlTemplate": "string" }, "playReady": { "customLicenseAcquisitionUrlTemplate": "string", "playReadyCustomAttributes": "string" }, "widevine": { "customLicenseAcquisitionUrlTemplate": "string" } }, "enabledProtocols": { "dash": true, "download": true, "hls": true, "smoothStreaming": true } }, "commonEncryptionCenc": { "clearKeyEncryptionConfiguration": { "customKeysAcquisitionUrlTemplate": "string" }, "clearTracks": [ { "trackSelections": [ { "operation": "Unknown", "property": "Unknown", "value": "string" } ] } ], "contentKeys": { "defaultKey": { "label": "string", "policyName": "string" }, "keyToTrackMappings": [ { "label": "string", "policyName": "string", "tracks": [ { "trackSelections": [ { "operation": "Unknown", "property": "Unknown", "value": "string" } ] } ] } ] }, "drm": { "playReady": { "customLicenseAcquisitionUrlTemplate": "string", "playReadyCustomAttributes": "string" }, "widevine": { "customLicenseAcquisitionUrlTemplate": "string" } }, "enabledProtocols": { "dash": true, "download": true, "hls": true, "smoothStreaming": true } }, "defaultContentKeyPolicyName": "string", "envelopeEncryption": { "clearTracks": [ { "trackSelections": [ { "operation": "Unknown", "property": "Unknown", "value": "string" } ] } ], "contentKeys": { "defaultKey": { "label": "string", "policyName": "string" }, "keyToTrackMappings": [ { "label": "string", "policyName": "string", "tracks": [ { "trackSelections": [ { "operation": "Unknown", "property": "Unknown", "value": "string" } ] } ] } ] }, "customKeyAcquisitionUrlTemplate": "string", "enabledProtocols": { "dash": true, "download": true, "hls": true, "smoothStreaming": true } }, "noEncryption": { "enabledProtocols": { "dash": true, "download": true, "hls": true, "smoothStreaming": true } } }, "id": "string", "name": "name", "systemData": { "createdAt": "2024-01-15T09:30:00Z", "createdBy": "string", "createdByType": "User", "internalId": "string", "lastModifiedAt": "2024-01-15T09:30:00Z", "lastModifiedBy": "string", "lastModifiedByType": "User" }, "type": "string" } ], "@odata.nextLink": "string" } ``` **SDK Code** ```python import requests url = "https://app.mk.io/api/v1/projects/project_name/media/streamingPolicies" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.mk.io/api/v1/projects/project_name/media/streamingPolicies'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://app.mk.io/api/v1/projects/project_name/media/streamingPolicies" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://app.mk.io/api/v1/projects/project_name/media/streamingPolicies") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://app.mk.io/api/v1/projects/project_name/media/streamingPolicies") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://app.mk.io/api/v1/projects/project_name/media/streamingPolicies', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.mk.io/api/v1/projects/project_name/media/streamingPolicies"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://app.mk.io/api/v1/projects/project_name/media/streamingPolicies")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```