> 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 URL paths

POST https://app.mk.io/api/v1/projects/{project_name}/media/streamingLocators/{locator_name}/listPaths
Content-Type: application/json

ListPaths returns the set of valid streaming paths for a given Streaming Locator. A distinct set of paths
is returned for each type of DRM configured, per the 'EnabledProtocols' property of the streaming policy.

RBAC Capability Required: `ams.streaminglocator.create`

Reference: https://mediakind.ferndocs.com/mkio/api/media/streaming-locators/list-url-paths

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `project_name` (string, required)
- `locator_name` (string, required)

### Body (application/json)

This endpoint expects a StreamingLocatorListPathsSchema.

- `urlStyle` (enum, optional, default: AMS) — The style of URL associated to the streaming endpoint. Default is 'AMS'.
  - Allowed values: `AMS`, `Aquila`, `Unified`

## Response

### 200

Streaming locator paths returned.

- `downloadPaths` (list of string, required) — The download paths for the locator.
- `drm` (map from string to StreamingLocatorDrm, required) — The license acquisition URLs for configured DRM types.
- `streamingPaths` (list of StreamingLocatorListPathsStreamingPaths, required) — The streaming paths for the locator.

## 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

### StreamingLocatorDrm

- `licenseAcquisitionUrl` (string, required) — The license acquisition URL for the DRM.
- `certificateUrl` (string, optional) — The URL for obtaining the streaming certificate.

### StreamingLocatorListPathsStreamingPaths

- `encryptionScheme` (enum, required) — The encryption scheme used for the path.
  - Allowed values: `NoEncryption`, `EnvelopeEncryption`, `CommonEncryptionCenc`, `CommonEncryptionCbcs`
- `paths` (list of string, required) — The paths for the locator.
- `streamingProtocol` (enum, required) — The streaming protocol used for the path.
  - Allowed values: `Hls`, `Dash`, `Download`, `SmoothStreaming`

### 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.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "downloadPaths": [
    "string"
  ],
  "drm": {},
  "streamingPaths": [
    {
      "encryptionScheme": "NoEncryption",
      "paths": [
        "string"
      ],
      "streamingProtocol": "Hls"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://app.mk.io/api/v1/projects/project_name/media/streamingLocators/locator_name/listPaths"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.mk.io/api/v1/projects/project_name/media/streamingLocators/locator_name/listPaths';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.mk.io/api/v1/projects/project_name/media/streamingLocators/locator_name/listPaths"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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/locator_name/listPaths")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://app.mk.io/api/v1/projects/project_name/media/streamingLocators/locator_name/listPaths")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.mk.io/api/v1/projects/project_name/media/streamingLocators/locator_name/listPaths', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.mk.io/api/v1/projects/project_name/media/streamingLocators/locator_name/listPaths");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://app.mk.io/api/v1/projects/project_name/media/streamingLocators/locator_name/listPaths")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```