Create a playbackId | FastPix Developer Documentation

curl -X POST https://api.fastpix.com/v1/live/streams/8717422d89288ad5958d4a86e9afe2a2/playback-ids \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "accessPolicy": "public",
  "accessRestrictions": {
    "domains": {
      "defaultPolicy": "deny",
      "allow": [
        "example.com"
      ],
      "deny": []
    },
    "userAgents": {
      "defaultPolicy": "allow",
      "allow": [],
      "deny": []
    }
  }
}'

{
  "success": true,
  "data": {
    "id": "88b7ac0f-2504-4dd5-b7b4-d84ab4fee1bd",
    "accessPolicy": "public",
    "accessRestrictions": {
      "domains": {
        "defaultPolicy": "allow",
        "allow": [],
        "deny": []
      },
      "userAgents": {
        "defaultPolicy": "allow",
        "allow": [],
        "deny": []
      }
    }
  }
}

Generates a new playback ID for the live stream, allowing viewers to access the stream through this ID. The playback ID can be shared with viewers for direct access to the live broadcast.

By calling this endpoint with the streamId, FastPix returns a unique playbackId, which can be used to stream the live content.

Example

A media platform needs to distribute a unique playback ID to users for an exclusive live concert. The platform can also embed the stream on various partner websites.

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

streamIdstringRequired

After creating a new live stream, FastPix assigns a unique identifier to the stream.

Request

This endpoint expects an object.

accessPolicyenumOptionalDefaults to public

Basic access policy for media content

Allowed values:

accessRestrictionsobjectOptional

Optional domain and user-agent access restrictions applied to the playback ID.

Response

New PlaybackId created successfully

successbooleanOptional

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

dataobjectOptional