Update user-agent restrictions for a playback ID | FastPix Developer Documentation

How it works:

Make a PATCH request with your desired user-agent access configuration.
Set a default policy (allow or deny) and specify user agents in the allow or deny lists.
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.

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.

Authentication

AuthorizationBasic

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

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. - <b>Username:</b> Access Token ID - <b>Password:</b> Secret Key Activate your FastPix account to generate your API credentials. <a href="https://fastpix.com/docs/getting-started/activate-your-account" target="_blank">See the guide here</a>

Path parameters

streamIdstringRequired

playbackIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.

defaultPolicyenumOptionalDefaults to allow

The default behavior when a user agent is not listed in allow or deny.

Allowed values:

allowlist of stringsOptional

List of user-agent substrings explicitly allowed. Maximum 25 entries.

denylist of stringsOptional

List of user-agent substrings explicitly denied. Maximum 25 entries.

Response

Successfully updated user-agent restrictions

successbooleanOptional

Shows the request status. Returns true for success and false for failure.

dataobjectOptional