Run an auto updater now

POST/editor/api/v1/playlists/{pid}/updaters/{id}/run/

Called with a playlist editor API token. How

Syncs now, in a background task: every kind it syncs, or only the kinds given. Refused while it is already running.

Path parameters

idintegerrequired
pidstring (uuid)required

Headers

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

Body

kindsstring[]
Some of live, movie and series (default: all).

Response

202 OK

jobstring (uuid)required
The background task: follow it with GET /editor/jobs/{id}/ (/editor/api/v1/jobs/{id}/ with a token).

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/updaters/1/run/' \
  -H "Authorization: Bearer $EDITOR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "kinds": [
    "string"
  ]
}'

Python

import os
import requests

response = requests.post(
    "https://panel.example.com/editor/api/v1/playlists/1/updaters/1/run/",
    headers={"Authorization": f"Bearer {os.environ['EDITOR_TOKEN']}"},
    json={
        "kinds": [
            "string"
        ]
    },
)
response.raise_for_status()
print(response.json())

JavaScript

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

Response 202

{
  "job": "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b"
}

Run an auto updater now

Path parameters#

Headers#

Body#

Response#