> 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 Destinations GET https://app.mk.io/api/v1/projects/{project_name}/media/destinations List destinations on the specified project. To learn more about destinations, read [Destinations](doc:destinations). ## Listing, Sorting and Filtering Destinations This endpoint returns the list of destinations 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`, `displayName`, `id`, `labels`, `name`, `status/state`, `updated`, `updatedBy` ### Filtering There are two ways to filter the set of returned destinations from this endpoint - the first is to use the `$filter` query parameter, the second is to use the `$label_key` and `$label` query parameters. The `$filter` query parameter allows for destinations 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`, `displayName`, `id`, `labels`, `name`, `status/state`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName` `$label_key` and `$label` are specific to querying destinations based on their labels. Labels are a set of key-value pairs that can be used to identify destinations with any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of destinations. ### Examples: `?$top=10` - Returns only the first 10 destinations from the list. `?$orderby=name desc` - Sorts destinations by name in descending order. `?$filter=name eq 'descriptive name'` - Returns destinations that match the provided name. `?$orderby=created desc` - Sorts destinations by creation date in descending order. `?$filter=created ge 2021-01-01T00:00:00Z` - Returns destinations created after January 1, 2021. `?$label=studio=paravalley` - Returns destinations with the label `studio` set to `paravalley`. `?$label=release-date~2023` - Returns destinations with the label `release-date` set to a value that contains `2023`. `?$label_key=studio&label_key=release-date` - Returns destinations with any value set for the `studio` label and the `release-date` label. RBAC Capability Required: `flow.destination.get` Reference: https://mediakind.ferndocs.com/mkio/api/media/destinations/list-destinations ## 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. - `$label_key` (string, optional) — Filters the set to the specified label key. If multiple $label_keys are specified, matching items must have all labels. - `$label` (string, optional) — Filters the set to the specified label key/value pair. Supports equality, inequality, and inexact matching. If multiple values are provided for the same key, items matching either value will be returned. ## Response ### 200 List of destinations - `supplemental` (ListResponseSupplementalSchema, required) — Supplemental info - `value` (list of DestinationGetSchema, required) — A list of Destinations. - `@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 ### DestinationGetSchema - `kind` (string, required) — The kind of record. - `metadata` (MetadataSchema, required) — Destination metadata. - `spec` (DestinationBodySpec, required) — Destination specification. - `status` (DestinationStatusSchema, required) — Destination status. ### 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 ### MetadataSchema - `id` (string, required) — The ID of the resource - `created` (datetime, optional) — The time when the resource was created - `createdBy` (string, optional) — ID of the user who created the resource - `createdByEmail` (string, optional) — Email of the user who created the resource - `displayName` (string, optional) — The display name of the resource - `labels` (map from string to string, optional) — A dictionary of labels associated with the resource - `name` (string, optional) — The name of the resource - `updated` (datetime, optional) — The time when the resource was last updated - `updatedBy` (string, optional) — ID of the user who last updated the resource - `updatedByEmail` (string, optional) — Email of the user who last updated the resource ### DestinationBodySpec - `aquilaSourceId` (string, optional) — The ID of an Aquila source to be used as the destination for a flow. - `networkName` (string, optional) — Name of the \<\> that this destination is available on. Only \<\>s that can reach this network will be able to use this destination. - `transport` (TransportSpecJsonFragment, optional) — Details of the \<\> that the content will be carried on. To learn more about the kinds of transport that can be configured, read [Set up transports on sources and destinations](doc:set-up-transports). ### DestinationStatusSchema - `networkDisplayName` (string, optional) — The display name of the network this destination is available on. - `state` (enum, optional) — Indicates if the destination is currently in use by any active \<\>s. - Allowed values: `Inactive`, `Active` - `transport` (TransportStatusJsonFragment, optional) — Transport status information for the destination. ### TransportSpecJsonFragment - `type` (enum, required) — Type of transport. This field cannot be modified, only set during creation. - Allowed values: `UDP`, `SDI`, `SRTCaller`, `SRTListener`, `HLSPullInput`, `RTMPPushOutput` - `allowList` (list of string, optional) — List of IP addresses that are allowed to connect, if the transport type supports it. The following transport types can use the `allowList` field: `SRTListener`. - `encryptionStandard` (enum, optional, default: None) — Encryption standard for the transport, if the transport type supports it. The following transport types can use the `encryptionStandard` field: `SRTCaller`, `SRTListener`. This field cannot be modified, only set during creation. - Allowed values: `None`, `AES128`, `AES192`, `AES256` - `ipResource` (IpResourceJsonFragment, optional) — Add an IP resource reservation for the transport. This is necessary for \<\>s and \<\>s that need to access a \<\> through a public IP address or public URL. The following transport types can use the `ipResource` field: `SRTListener`. This field cannot be modified, only set during creation. - `latency` (double, optional, default: 0.5) — Minimum Latency, in seconds, for the transport, if the transport type supports it. The following transport types can use the `latency` field: `SRTCaller`, `SRTListener`. This field cannot be modified, only set during creation. - `maxBitrate` (integer, optional, default: 30000000) — Maximum bitrate, in bits per second, expected through each individual connection to the Listener. The following transport types can use the `maxBitrate` field: `SRTCaller`, `SRTListener`. This field cannot be modified, only set during creation. - `maxConnections` (integer, optional, default: 10) — Maximum number of connections for a Listener destination. Overrides the flow output maxConnections setting if present. The following transport types can use the `maxConnections` field: `SRTCaller`, `SRTListener`. This field cannot be modified, only set during creation. - `maxOverheadBandwidth` (integer, optional, default: 100) — Maximum Overhead Bandwidth, as an integer (e.g., 100), for the transport, if the transport type supports it. The following transport types can use the `maxOverheadBandwidth` field: `SRTCaller`, `SRTListener`. This field cannot be modified, only set during creation. - `passPhrase` (string, optional, default: ) — Password phrase for the transport, if the transport type supports it. The following transport types can use the `passPhrase` field: `SRTCaller`, `SRTListener`. - `password` (string, optional) — Password for HLS pull authentication. For sources, this field can be updated via PATCH when the transport type is `HLSPullInput`. For all other transport types, it can only be set during creation. - `port` (integer, optional, default: 5000) — Port for the transport, if the transport type supports it. The following transport types need the `port` field: `SRTListener`. This field cannot be modified, only set during creation. - `streamId` (string, optional, default: ) — The SRT stream ID sent by the caller during the SRT handshake. Used by the listener to identify or route the stream. Optional. The following transport types can use the `streamId` field: `SRTCaller`. This field cannot be modified, only set during creation. - `streamKey` (string, optional, default: ) — The RTMP stream key (appended to the URL when connecting). The following transport types need the `streamKey` field: `RTMPPushOutput`. This field cannot be modified, only set during creation. - `url` (string, optional) — The URL for the transport, if the transport type supports it. The following transport types need the `url` field: `SRTCaller`, `UDP`, `SDI`, `HLSPullInput`, `RTMPPushOutput`. For sources, this field can be updated via PATCH when the transport type is `SRTCaller` or `HLSPullInput`. For all other transport types, and for destinations, it can only be set during creation. - `user` (string, optional) — Username for HLS pull authentication. For sources, this field can be updated via PATCH when the transport type is `HLSPullInput`. For all other transport types, it can only be set during creation. - `urls` (list of string, optional, deprecated) — DEPRECATED: Use `url` instead. This is provided for backwards compatibility and will be removed in a future release. If `urls` is used, only the first URL will be considered. If both `url` and `urls` are provided, `url` takes precedence. ### TransportStatusJsonFragment - `urls` (list of string, optional) — The URLs configured or allocated/discovered for the transport. Where the `spec.transport.url` field is supported by the transport `type` (e.g. an SRTCaller), the `urls` field will contain that data. Where the system automatically allocates/discovers one or more URLs (e.g. an SRTListener), the `urls` field will contain that data. ### IpResourceJsonFragment - `type` (enum, required) — Type of IP resource reservation: - `External` means reserve a public IP address, - `Internal` means reserve an internal IP address (please contact MediaKind personnel for usage), and - `None` means don't try to reserve an IP resource. Transports between on-prem devices don't need to explicitly reserve an IP address. - Allowed values: `None`, `External`, `Internal` ## 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": [ { "kind": "string", "metadata": { "id": "string", "created": "2024-01-15T09:30:00Z", "createdBy": "string", "createdByEmail": "string", "displayName": "string", "labels": { "label1": "value1", "label2": "value2" }, "name": "string", "updated": "2024-01-15T09:30:00Z", "updatedBy": "string", "updatedByEmail": "string" }, "spec": { "aquilaSourceId": "1bfa932d36604506824fdd78642ad08f", "networkName": "network-wan", "transport": { "type": "UDP", "allowList": [ "string" ], "encryptionStandard": "None", "ipResource": { "type": "None" }, "latency": 0.5, "maxBitrate": 30000000, "maxConnections": 10, "maxOverheadBandwidth": 100, "passPhrase": "", "password": "string", "port": 5000, "streamId": "", "streamKey": "", "url": "string", "user": "string", "urls": [ "string" ] } }, "status": { "networkDisplayName": "string", "state": "Inactive", "transport": { "urls": [ "string" ] } } } ], "@odata.nextLink": "string" } ``` **SDK Code** ```python import requests url = "https://app.mk.io/api/v1/projects/project_name/media/destinations" 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/destinations'; 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/destinations" 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/destinations") 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/destinations") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://app.mk.io/api/v1/projects/project_name/media/destinations', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.mk.io/api/v1/projects/project_name/media/destinations"); 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/destinations")! 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() ```