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
  • LIVE STREAM API
    • Overview
      • POSTCreate a simulcast
      • GETGet a specific simulcast
      • PUTUpdate a simulcast
      • DELDelete a simulcast
  • VIDEO DATA API
    • Overview
LogoLogo
StatusSupportDiscussionsLog inSign Up
LIVE STREAM APISimulcast stream

Update a simulcast

PUT
https://api.fastpix.com/v1/live/streams/:streamId/simulcast/:simulcastId
PUT
/v1/live/streams/:streamId/simulcast/:simulcastId
$curl -X PUT https://api.fastpix.com/v1/live/streams/9714422d89287ad5758d4a86e9afe1a2/simulcast/8717422d89288ad5958d4a86e9afe2a2 \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{
>  "isEnabled": true,
>  "metadata": {
>    "simulcast_name": "Tech today"
>  }
>}'
200Updated
1{
2  "success": true,
3  "data": {
4    "simulcastId": "8717422d89288ad5958d4a86e9afe2a2",
5    "url": "rtmp://hyd01.contribute.live-video.net/app/",
6    "streamKey": "live_1012464221_DuM8W004MoZYNxQEZ0czODgfHCFBhk",
7    "isEnabled": false,
8    "metadata": {
9      "simulcast_name": "Tech today"
10    }
11  }
12}
Updates the status of a specific simulcast linked to a parent live stream. You can enable or disable the simulcast at any time while the parent stream is active or idle. After the live stream is disabled, the simulcast can no longer be modified. Webhook event: <a href="https://docs.fastpix.io/docs/live-events#videolive_streamsimulcast_targetupdated">video.live_stream.simulcast_target.updated</a> #### Example When a `PATCH` request is made to this endpoint, the API updates the status of the simulcast. This can be useful for pausing or resuming a simulcast on a particular platform without stopping the parent live stream.
Was this page helpful?
Previous

Delete a simulcast

Next
Built with

Updates the status of a specific simulcast linked to a parent live stream. You can enable or disable the simulcast at any time while the parent stream is active or idle. After the live stream is disabled, the simulcast can no longer be modified.

Webhook event: video.live_stream.simulcast_target.updated

Example

When a PATCH request is made to this endpoint, the API updates the status of the simulcast. This can be useful for pausing or resuming a simulcast on a particular platform without stopping the parent live stream.

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
Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
simulcastIdstringRequired
When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.

Request

This endpoint expects an object.
isEnabledbooleanOptionalDefaults to true
When set to false, the simulcast is disabled for the specified stream.
metadatamap from strings to stringsOptional

You can search for videos with specific key-value pairs using metadata, when you tag a video in “key”:“value” pairs.

Response

Stream's simulcast details fetched successfully
successboolean
Shows the request status. Returns true for success and false for failure.
dataobject
Displays the result of the request.