For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusSupportDiscussionsLog inSign Up
Docs HomeAPI ReferenceVideo on DemandAI FeaturesLive StreamingVideo PlayerVideo DataCloud PlayoutRecipes
Docs HomeAPI ReferenceVideo on DemandAI FeaturesLive StreamingVideo PlayerVideo DataCloud PlayoutRecipes
  • ACTIVATE ACCOUNT
    • Create account
  • PRODUCT OS API
    • Overview
  • ERROR CODES
    • Error codes
  • VIDEO ON DEMAND API
    • Overview
      • GETGet all playback IDs details for a media
      • POSTCreate a playback ID
      • DELDelete a playback ID
      • GETGet a playback ID
      • PATCHUpdate domain restrictions for a playback ID
      • PATCHUpdate user-agent restrictions for a playback ID
  • LIVE STREAM API
    • Overview
  • VIDEO DATA API
    • Overview
LogoLogo
StatusSupportDiscussionsLog inSign Up
VIDEO ON DEMAND APIPlayback

Update domain restrictions for a playback ID

PATCH
https://api.fastpix.com/v1/on-demand/:mediaId/playback-ids/:playbackId/domains
PATCH
/v1/on-demand/:mediaId/playback-ids/:playbackId/domains
$curl -X PATCH https://api.fastpix.com/v1/on-demand/5ebfa8f7-3ff1-4a35-8b1a-d3a16e22184c/playback-ids/0199deff-9aef-457e-9461-7a28afdf8773/domains \
> -H "Content-Type: application/json" \
> -u "<username>:<password>" \
> -d '{}'
200Updated
1{
2 "success": true,
3 "data": {
4 "defaultPolicy": "allow",
5 "allow": [
6 "yourdomain.com",
7 "yourworkdomain.com"
8 ],
9 "deny": [
10 "sampledomain.com"
11 ]
12 }
13}
This endpoint updates domain-level restrictions for a specific playback ID associated with a media asset. It allows you to restrict playback to specific domains or block known unauthorized domains. **How it works:** 1. Make a `PATCH` request to this endpoint with your desired domain access configuration. 2. Set a default policy (`allow` or `deny`) and specify domain names in the `allow` or `deny` lists. 3. This is commonly used to restrict video playback to your website or approved client domains. **Example:** A streaming service can allow playback only from `example.com` and deny all others by setting: `"defaultPolicy": "deny"` and `"allow": ["example.com"]`.
Was this page helpful?
Previous

Update user-agent restrictions for a playback ID

Next
Built with

This endpoint updates domain-level restrictions for a specific playback ID associated with a media asset. It allows you to restrict playback to specific domains or block known unauthorized domains.

How it works:

  1. Make a PATCH request to this endpoint with your desired domain access configuration.
  2. Set a default policy (allow or deny) and specify domain names in the allow or deny lists.
  3. This is commonly used to restrict video playback to your website or approved client domains.

Example: A streaming service can allow playback only from example.com and deny all others by setting: "defaultPolicy": "deny" and "allow": ["example.com"].

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

Path parameters

mediaIdstringRequiredformat: "uuid"
playbackIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.
defaultPolicyenumOptionalDefaults to allow

Specify the fallback behavior for domains that are not listed in the allow or deny lists.

Allowed values:
allowlist of stringsOptional
List of domains explicitly allowed to play the media.
denylist of stringsOptional
List of domains explicitly denied from accessing the media.

Response

Successfully updated domain restrictions
successboolean
Shows the request status. Returns true for success and false for failure.
dataobject