Download a playlist backup

POST/editor/api/v1/playlists/{pid}/backup/

Called with a playlist editor API token. How

A backup file (.mbk) of the playlist, sent as it is written. private (the default) holds everything, customers and logins too, and restores only on this panel, over the playlist. shareable holds no customers and restores anywhere, as a new playlist. sections picks what it holds (default: all).

Path parameters

pidstring (uuid)required

Headers

X-Token-Passwordstring
The token's own password, when it was made with one.

Body

typestring
Default: "private"
sectionsstring[]
One of: "live" "movie" "series" "users" "updaters"
Default: ["live","movie","series","updaters","users"]

Response

200 OK

string (binary)

Errors

400 Something sent is not valid. Each field that is wrong is named with what is wrong.
401 No credential, or one that is wrong, expired or revoked.
403 The account, or the key's or app's scopes, may not do this.
404 Nothing with this id, or nothing the account can see.
429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means

cURL

curl -X POST 'https://panel.example.com/editor/api/v1/playlists/1/backup/' \
  -H "Authorization: Bearer $EDITOR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "private",
  "sections": [
    "live",
    "movie",
    "series",
    "updaters",
    "users"
  ]
}'

Python

import os
import requests

response = requests.post(
    "https://panel.example.com/editor/api/v1/playlists/1/backup/",
    headers={"Authorization": f"Bearer {os.environ['EDITOR_TOKEN']}"},
    json={
        "type": "private",
        "sections": [
            "live",
            "movie",
            "series",
            "updaters",
            "users"
        ]
    },
)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://panel.example.com/editor/api/v1/playlists/1/backup/', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.EDITOR_TOKEN}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "type": "private",
    "sections": [
      "live",
      "movie",
      "series",
      "updaters",
      "users"
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status}`);
console.log(await response.json());

Response 200

"(file)"

Download a playlist backup

Path parameters#

Headers#

Body#

Response#