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

# Create or update Streaming Locator

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

Create or update a Streaming Locator.
When updating a streaming locator, only `start time`, `end time` and `suppressed` can be modified.

RBAC Capability Required: `ams.streaminglocator.create` or `ams.streaminglocator.update`

Reference: https://mediakind.ferndocs.com/mkio/api/media/streaming-locators/create-or-update-streaming-locator

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

- `properties` (StreamingLocatorPutProperties, required) — Properties for streaming locator

## Response

### 200

Updated

- `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"

### 201

Created

- `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"

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

### 409 Conflict Error

Conflict

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

### StreamingLocatorPutProperties

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

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

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

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

### Example 1

**Request**

```json
{
  "properties": {
    "assetName": "string",
    "streamingPolicyName": "string"
  }
}
```

**Response**

```json
{
  "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"
}
```

**SDK Code**

```python
import requests

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

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

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

print(response.json())
```

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

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"

	payload := strings.NewReader("{\n  \"properties\": {\n    \"assetName\": \"string\",\n    \"streamingPolicyName\": \"string\"\n  }\n}")

	req, _ := http.NewRequest("PUT", 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")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"properties\": {\n    \"assetName\": \"string\",\n    \"streamingPolicyName\": \"string\"\n  }\n}"

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.put("https://app.mk.io/api/v1/projects/project_name/media/streamingLocators/locator_name")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"properties\": {\n    \"assetName\": \"string\",\n    \"streamingPolicyName\": \"string\"\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://app.mk.io/api/v1/projects/project_name/media/streamingLocators/locator_name', [
  'body' => '{
  "properties": {
    "assetName": "string",
    "streamingPolicyName": "string"
  }
}',
  '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");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"properties\": {\n    \"assetName\": \"string\",\n    \"streamingPolicyName\": \"string\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["properties": [
    "assetName": "string",
    "streamingPolicyName": "string"
  ]] 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")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
```

### Example 2

**Request**

```json
{
  "properties": {
    "assetName": "string",
    "streamingPolicyName": "string"
  }
}
```

**Response**

```json
{
  "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"
}
```

**SDK Code**

```python
import requests

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

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

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

print(response.json())
```

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

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"

	payload := strings.NewReader("{\n  \"properties\": {\n    \"assetName\": \"string\",\n    \"streamingPolicyName\": \"string\"\n  }\n}")

	req, _ := http.NewRequest("PUT", 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")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"properties\": {\n    \"assetName\": \"string\",\n    \"streamingPolicyName\": \"string\"\n  }\n}"

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.put("https://app.mk.io/api/v1/projects/project_name/media/streamingLocators/locator_name")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"properties\": {\n    \"assetName\": \"string\",\n    \"streamingPolicyName\": \"string\"\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://app.mk.io/api/v1/projects/project_name/media/streamingLocators/locator_name', [
  'body' => '{
  "properties": {
    "assetName": "string",
    "streamingPolicyName": "string"
  }
}',
  '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");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"properties\": {\n    \"assetName\": \"string\",\n    \"streamingPolicyName\": \"string\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["properties": [
    "assetName": "string",
    "streamingPolicyName": "string"
  ]] 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")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
```