> 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 Locators GET https://app.mk.io/api/v1/projects/{project_name}/media/streamingLocators ## Listing, Sorting and Filtering Streaming Locators This endpoint returns the list of streaming locators 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`, `properties/endTime`, `properties/startTime`, `updated`, `updatedBy` ### Filtering The `$filter` query parameter allows for streaming locators 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/assetName`, `properties/created`, `properties/endTime`, `properties/startTime`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName` ### Examples: `?$top=10` - Returns only the first 10 streaming locators from the list. `?$orderby=name desc` - Sorts streaming locators by name in descending order. `?$filter=name eq 'descriptive name'` - Returns streaming locators that match the provided name. `?$orderby=created desc` - Sorts streaming locators by creation date in descending order. `?$filter=created ge 2021-01-01T00:00:00Z` - Returns streaming locators created after January 1, 2021. RBAC Capability Required: `ams.streaminglocator.get` Reference: https://mediakind.ferndocs.com/mkio/api/media/streaming-locators/list-streaming-locators ## 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 storage accounts - `supplemental` (ListResponseSupplementalSchema, required) — Supplemental info - `value` (list of StreamingLocatorSchema, required) — The list of streaming locators - `@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 ### StreamingLocatorSchema - `properties` (StreamingLocatorProperties, required) — Properties for streaming locator - `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 ### StreamingLocatorProperties - `assetName` (string, required) — The name of the asset used by this streaming locator - `streamingPolicyName` (string, required) — The name of the streaming policy used by this streaming locator.\ You may specify a custom policy by name, or used one of the predefined policies.\ To get the list of valid policy options use the `GET /api/v1/projects/{project_name}/media/streamingPolicies` endpoint. - `alternativeMediaId` (string, optional) — The alternative media id of the asset used by this streaming locator - `contentId` (string, optional) — Optional content ID. Only valid when an external key server is used. - `contentKeys` (list of StreamingLocatorContentKey, optional) — The content keys used by this streaming locator - `defaultContentKeyPolicyName` (string, optional) — The default content key policy name used by this streaming locator. - `defaultManifestFilename` (string, optional) — Manifest filename used with streaming endpoints that have urlStyle set to 'Aquila' or 'Unified'. For example: manifest.ism (for MP4 assets), manifest.mpd (for TS assets), index.qfm (for live events) - `endTime` (datetime, optional) — The end time of the streaming locator - `filters` (list of string, optional) — A list of asset or account filters to apply to the streaming locator. - `provisioningState` (enum, optional) — The provisioning state of the streaming locator. Set by the system. One of InProgress, Succeeded, Failed. - Allowed values: `InProgress`, `Succeeded`, `Failed` - `resourceState` (enum, optional) — The runtime state of the streaming locator. Set by the system. - Allowed values: `Creating`, `Updating`, `Deleting`, `Created`, `Deleted`, `Error` - `startTime` (datetime, optional) — The start time of the streaming locator - `streamingLocatorId` (string, optional) — The streaming locator id - `suppressed` (boolean, optional, default: false) — Optional configuration for output suppression. A suppressed locator will return a 404 HTTP response to requests, in the same way it would if the `startTime` had not yet been reached. The 404 code can be overridden with a different status code by setting `preAvailabilityStatusCode` in a custom catalog in a Streaming Policy. ### 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` ### StreamingLocatorContentKey - `id` (string, required) — The id of the content key - `labelReferenceInStreamingPolicy` (string, optional) — The label reference in the streaming policy - `policyName` (string, optional) — The name of the policy - `tracks` (list of StreamingLocatorTrackSelection, optional) — Not currently supported. The tracks which use this content key - `type` (enum, optional) — The streaming locator content key type - Allowed values: `CommonEncryptionCenc`, `CommonEncryptionCbcs`, `EnvelopeEncryption` - `value` (string, optional) — The value of the content key ### StreamingLocatorTrackSelection - `trackSelections` (list of StreamingLocatorTrackPropertyCondition, required) — The track selections ### StreamingLocatorTrackPropertyCondition - `operation` (TrackPropertyCompareOperation, required) — The track property comparison operation - `property` (string, required) — The track property to compare against - `value` (string, required) — The track property value. ### TrackPropertyCompareOperation - `Equal` (string, required) — The track property comparison operation - `Unknown` (string, required) — The track property comparison operation ## 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": { "assetName": "string", "streamingPolicyName": "string", "alternativeMediaId": "string", "contentId": "string", "contentKeys": [ { "id": "string", "labelReferenceInStreamingPolicy": "string", "policyName": "string", "tracks": [ { "trackSelections": [ { "operation": { "Equal": "string", "Unknown": "string" }, "property": "string", "value": "string" } ] } ], "type": "CommonEncryptionCenc", "value": "string" } ], "defaultContentKeyPolicyName": "string", "defaultManifestFilename": "string", "endTime": "2024-01-15T09:30:00Z", "filters": [ "string" ], "provisioningState": "InProgress", "resourceState": "Creating", "startTime": "2024-01-15T09:30:00Z", "streamingLocatorId": "00000000-0000-0000-0000-000000000000", "suppressed": false }, "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/streamingLocators" 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/streamingLocators'; 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/streamingLocators" 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/streamingLocators") 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/streamingLocators") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://app.mk.io/api/v1/projects/project_name/media/streamingLocators', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.mk.io/api/v1/projects/project_name/media/streamingLocators"); 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/streamingLocators")! 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() ```