Replace player configuration

PUT https://octopus.livepush.io/players/{player_id}/config

Base URL https://octopus.livepush.io — Core Streams & Media APIs

Sets the player's embed configuration — the player equivalent of the /streams/{stream_id}/embed/* endpoints, as a single call.

This replaces the entire config object rather than merging into it. Fields you omit are cleared, so always send the complete configuration. Unknown fields are stripped rather than rejected.

Not used by the dashboard.

Requires a token with CanWritePlayers.

Authorization

Send a valid access token in the Authorization header.

bearerAuth — Bearer token (JWT)

headers.txt

Authorization: Bearer YOUR_API_TOKEN

Try it

PUT https://octopus.livepush.io/players/{player_id}/config — This call changes live data on your account.

Parameters

Path parameters

player_id string required

Unique identifier of the player.

example: pl_xxxxxxxxxxxx

Request body

application/json required

embedTitle string
embedColor string
embedAutoplay boolean
embedAbr boolean

Adaptive bitrate playback.
embedLiveRewind boolean
embedPremier boolean
embedPremierText string
embedOfflineText string
embedOfflineTextAlt string
embedPassword string

write-only
embedDomains string[]

Allowed hosting domains. Empty allows every domain.
embedGEOList string[]

Allowed country codes. Empty allows every country.
embedDisableViewersCount boolean
embedDisablePauseControl boolean
embedCoverId string
embedCoverFileName string
embedChannelIconURL string
embedChannelIconSize string
embedChannelIconPosition string
embedChannelIconLayout string
embedChannelIconAnchorURL string
maxConcurrentViewers integer

Hard cap on simultaneous viewers.

Example request body response.json

{
  "embedTitle": "Lobby screen",
  "embedColor": "#66d72f",
  "embedAutoplay": true,
  "embedAbr": false,
  "embedLiveRewind": false,
  "embedPremier": false,
  "embedPremierText": "string",
  "embedOfflineText": "string",
  "embedOfflineTextAlt": "string",
  "embedPassword": "string",
  "embedDomains": [
    "string"
  ],
  "embedGEOList": [
    "string"
  ],
  "embedDisableViewersCount": false,
  "embedDisablePauseControl": false,
  "embedCoverId": "string",
  "embedCoverFileName": "string",
  "embedChannelIconURL": "string",
  "embedChannelIconSize": "string",
  "embedChannelIconPosition": "string",
  "embedChannelIconLayout": "string",
  "embedChannelIconAnchorURL": "string",
  "maxConcurrentViewers": 0
}

Code samples

request.sh

curl -X PUT 'https://octopus.livepush.io/players/pl_xxxxxxxxxxxx/config' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "embedTitle": "Lobby screen",
    "embedColor": "#66d72f",
    "embedAutoplay": true,
    "embedAbr": false,
    "embedLiveRewind": false,
    "embedPremier": false,
    "embedPremierText": "string",
    "embedOfflineText": "string",
    "embedOfflineTextAlt": "string",
    "embedPassword": "string",
    "embedDomains": [
      "string"
    ],
    "embedGEOList": [
      "string"
    ],
    "embedDisableViewersCount": false,
    "embedDisablePauseControl": false,
    "embedCoverId": "string",
    "embedCoverFileName": "string",
    "embedChannelIconURL": "string",
    "embedChannelIconSize": "string",
    "embedChannelIconPosition": "string",
    "embedChannelIconLayout": "string",
    "embedChannelIconAnchorURL": "string",
    "maxConcurrentViewers": 0
  }'

const response = await fetch('https://octopus.livepush.io/players/pl_xxxxxxxxxxxx/config', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "embedTitle": "Lobby screen",
    "embedColor": "#66d72f",
    "embedAutoplay": true,
    "embedAbr": false,
    "embedLiveRewind": false,
    "embedPremier": false,
    "embedPremierText": "string",
    "embedOfflineText": "string",
    "embedOfflineTextAlt": "string",
    "embedPassword": "string",
    "embedDomains": [
      "string"
    ],
    "embedGEOList": [
      "string"
    ],
    "embedDisableViewersCount": false,
    "embedDisablePauseControl": false,
    "embedCoverId": "string",
    "embedCoverFileName": "string",
    "embedChannelIconURL": "string",
    "embedChannelIconSize": "string",
    "embedChannelIconPosition": "string",
    "embedChannelIconLayout": "string",
    "embedChannelIconAnchorURL": "string",
    "maxConcurrentViewers": 0
  }),
});

if (!response.ok) {
  throw new Error(`Livepush API error ${response.status}`);
}

const data = await response.json();

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json',
}

payload = {
    "embedTitle": "Lobby screen",
    "embedColor": "#66d72f",
    "embedAutoplay": True,
    "embedAbr": False,
    "embedLiveRewind": False,
    "embedPremier": False,
    "embedPremierText": "string",
    "embedOfflineText": "string",
    "embedOfflineTextAlt": "string",
    "embedPassword": "string",
    "embedDomains": [
        "string"
    ],
    "embedGEOList": [
        "string"
    ],
    "embedDisableViewersCount": False,
    "embedDisablePauseControl": False,
    "embedCoverId": "string",
    "embedCoverFileName": "string",
    "embedChannelIconURL": "string",
    "embedChannelIconSize": "string",
    "embedChannelIconPosition": "string",
    "embedChannelIconLayout": "string",
    "embedChannelIconAnchorURL": "string",
    "maxConcurrentViewers": 0
}

response = requests.put('https://octopus.livepush.io/players/pl_xxxxxxxxxxxx/config', headers=headers, json=payload, timeout=30)
response.raise_for_status()
data = response.json()

Responses

Setting applied.

application/json

success boolean

Example 200 response response.json

{
  "success": true
}

No response body.

No such player for this account.

Authorization#

Try it#

Parameters#