Update the source access of a media by ID

PATCH

https://api.fastpix.com/v1/on-demand/:mediaId/source-access

PATCH

/v1/on-demand/:mediaId/source-access

curl -X PATCH https://api.fastpix.com/v1/on-demand/4fa85f64-5717-4562-b3fc-2c963f66afa6/source-access \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "sourceAccess": true
}'

200Updated

{
  "success": true,
  "data": {
    "thumbnail": "https://venus-images.fastpix.dev/cf41c9f7-ece3-4efe-8d31-c6e000dc422b/thumbnail.png",
    "id": "eb56a668-0354-40c2-9233-f3197e1baabd",
    "workspaceId": "c788be40-91a5-4d2d-abf7-47398a6276a1",
    "metadata": {
      "key1": "value1"
    },
    "mediaQuality": "standard",
    "maxResolution": "1080p",
    "codecTier": "basic",
    "sourceResolution": "1080p",
    "status": "Ready",
    "sourceAccess": true,
    "playbackIds": [
      {
        "id": "cf41c9f7-ece3-4efe-8d31-c6e000dc422b",
        "accessPolicy": "public",
        "accessRestrictions": {
          "domains": {
            "defaultPolicy": "allow",
            "allow": [],
            "deny": []
          },
          "userAgents": {
            "defaultPolicy": "allow",
            "allow": [],
            "deny": []
          }
        }
      }
    ],
    "tracks": [
      {
        "id": "344fd5bc-82af-4d11-bc1c-785d9e6f9aef",
        "type": "video",
        "width": 1920,
        "height": 1080,
        "frameRate": "30/1",
        "status": "available"
      }
    ],
    "generatedSubtitles": [],
    "isAudioOnly": false,
    "subtitleAvailable": false,
    "duration": 10.5,
    "aspectRatio": "16:9",
    "createdAt": "2024-12-06T03:47:26.489888Z",
    "updatedAt": "2024-12-06T03:47:47.593400Z"
  }
}

This endpoint allows you to update the sourceAccess setting of an existing media file. The sourceAccess parameter determines whether the original media file is accessible or restricted. Setting this to true enables access to the media source, while setting it to false restricts access.

How it works

Make a PATCH request to this endpoint, replacing {mediaId} with the ID of the media you want to update.
Include the updated sourceAccess parameter in the request body.
You receive a response confirming the update to the media’s source access status.
Webhook events: video.media.source.ready, video.media.source.deleted

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"

The unique identifier assigned to the media when created. The value must be a valid UUID.

Request

This endpoint expects an object.

sourceAccessbooleanRequired

The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it.

Response

Media details updated successfully

successbooleanOptional

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

dataobjectOptional