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

How it works:

Make a PATCH request to this endpoint with your desired user-agent access configuration.
Specify a default policy (allow or deny) and provide specific allow or deny lists.
Use this to restrict access to specific browsers, devices, or bots.

Example: A developer may configure a playback ID to deny access from known scraping user-agents while allowing all others by default.

This endpoint allows updating user-agent restrictions for a specific playback ID associated with a media asset. It can be used to allow or deny specific user-agents during playback request evaluation. **How it works:** 1. Make a `PATCH` request to this endpoint with your desired user-agent access configuration. 2. Specify a default policy (`allow` or `deny`) and provide specific `allow` or `deny` lists. 3. Use this to restrict access to specific browsers, devices, or bots. **Example:** A developer may configure a playback ID to 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

mediaIdstringRequiredformat: "uuid"

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.

denylist of stringsOptional

List of user-agent substrings explicitly denied.

Response

Successfully updated user-agent restrictions

successbooleanOptional

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

dataobjectOptional