> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://fastpix.com/docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://fastpix.com/docs/_mcp/server.

# Update user-agent restrictions for a playback ID

PATCH https://api.fastpix.com/v1/live/streams/{streamId}/playback-ids/{playbackId}/user-agents
Content-Type: application/json

Updates user-agent access restrictions for a specific playback ID of a live stream. Allows or denies specific user agents during playback. Replaces the existing user-agent restrictions while leaving domain restrictions unchanged.

**How it works:**
1. Make a `PATCH` request with your desired user-agent access configuration.
2. Set a default policy (`allow` or `deny`) and specify user agents in the `allow` or `deny` lists.
3. Use this to restrict access to specific browsers, devices, or bots.

**Example:**
Deny access from known scraping user agents while allowing all others by default.


Reference: https://fastpix.com/docs/live-stream-api/live-playback/update-live-stream-user-agent-restrictions

## Authentication

- `Authorization` header (basic auth, required) — FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request. * Username: Access Token ID * Password: Secret Key Activate your FastPix account to generate your API credentials. See the guide here

## Request

### Path parameters

- `streamId` (string, required)
- `playbackId` (string, required)

### Body (application/json)

This endpoint expects an object.

- `defaultPolicy` (enum, optional, default: allow) — The default behavior when a user agent is not listed in `allow` or `deny`.
  - Allowed values: `allow`, `deny`
- `allow` (list of string, optional) — List of user-agent substrings explicitly allowed. Maximum 25 entries.
- `deny` (list of string, optional) — List of user-agent substrings explicitly denied. Maximum 25 entries.

## Response

### 200

Successfully updated user-agent restrictions

- `success` (boolean, optional) — Shows the request status. Returns true for success and false for failure.
- `data` (LiveStreamsStreamIdPlaybackIdsPlaybackIdUserAgentsPatchResponsesContentApplicationJsonSchemaData, optional)

## Types

### LiveStreamsStreamIdPlaybackIdsPlaybackIdUserAgentsPatchResponsesContentApplicationJsonSchemaData

- `defaultPolicy` (string, optional) — The default behavior for user agents not listed in the allow or deny lists.
- `allow` (list of string, optional) — List of user-agent substrings explicitly allowed.
- `deny` (list of string, optional) — List of user-agent substrings explicitly denied.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "success": true,
  "data": {
    "defaultPolicy": "allow",
    "allow": [
      "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36"
    ],
    "deny": [
      "PostmanRuntime/7.29.0"
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/playback-ids/0199deff-9aef-457e-9461-7a28afdf8773/user-agents"

payload = {}
headers = {
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers, auth=("<username>", "<password>"))

print(response.json())
```

```javascript
const url = 'https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/playback-ids/0199deff-9aef-457e-9461-7a28afdf8773/user-agents';
const credentials = btoa("<username>:<password>");

const options = {
  method: 'PATCH',
  headers: {
    Authorization: `Basic ${credentials}`,
    '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://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/playback-ids/0199deff-9aef-457e-9461-7a28afdf8773/user-agents"

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

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

	req.SetBasicAuth("<username>", "<password>")
	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://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/playback-ids/0199deff-9aef-457e-9461-7a28afdf8773/user-agents")

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

request = Net::HTTP::Patch.new(url)
request.basic_auth("<username>", "<password>")
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.patch("https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/playback-ids/0199deff-9aef-457e-9461-7a28afdf8773/user-agents")
  .basicAuth("<username>", "<password>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/playback-ids/0199deff-9aef-457e-9461-7a28afdf8773/user-agents', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
    'auth' => ['<username>', '<password>'],
]);

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

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/playback-ids/0199deff-9aef-457e-9461-7a28afdf8773/user-agents");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.PATCH);

request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = [
  "Authorization": "Basic \(credentials)",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/playback-ids/0199deff-9aef-457e-9461-7a28afdf8773/user-agents")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
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()
```