Servers

Check for updates

read Read: looks, changes nothing. Scopes

Query parameters#

• refreshstring

  1 asks the download server again now.

  One of: "1"

Response#

200 OK

• versionstringrequired

  The build the panel runs.

• releasestringrequiredcan be null

  The release it is, or null.

• trackstringrequired

  The release track of this license.

• sandboxbooleanrequired

  A test build: it is offered no release.

• latestobjectrequiredcan be null

  The newest release this license may have.

  • versionstringrequired

    The release, e.g. 2026.11.2.

  • published_atstring (date-time)requiredcan be null
  • notesstring

    What it brings, in plain words.

  • trackstring

    stable or beta.

  • ltsbooleanrequired

    A long-term release: one the panel may roll back to.

  • forcedbooleanrequired

    A security release: it cannot be rolled back.

  • allowedbooleanrequired

    Not older than the newest security release, so it may be installed.

  • buildsobjectrequired

    The build of each part: panel, ui and node (the streaming software).

• securitystringrequiredcan be null

  The newest security release, if any.

• must_updatebooleanrequired

  A security update is due: the panel installs it on its own.

• forced_currentbooleanrequired

  What runs is a security release: no rolling back.

• rollbackobject[]required

  The releases the panel may go back to.

  • versionstringrequired

    The release, e.g. 2026.11.2.

  • published_atstring (date-time)requiredcan be null
  • notesstring

    What it brings, in plain words.

  • trackstring

    stable or beta.

  • ltsbooleanrequired

    A long-term release: one the panel may roll back to.

  • forcedbooleanrequired

    A security release: it cannot be rolled back.

  • allowedbooleanrequired

    Not older than the newest security release, so it may be installed.

  • buildsobjectrequired

    The build of each part: panel, ui and node (the streaming software).

• newsobject[]required

  Notes of every newer release, newest first.

  • versionstringrequired
  • published_atstring (date-time)requiredcan be null
  • notesstringrequired
• releasesobject[]required

  Every release, to tell which one each server runs.

  • versionstringrequired

    The release, e.g. 2026.11.2.

  • published_atstring (date-time)requiredcan be null
  • notesstring

    What it brings, in plain words.

  • trackstring

    stable or beta.

  • ltsbooleanrequired

    A long-term release: one the panel may roll back to.

  • forcedbooleanrequired

    A security release: it cannot be rolled back.

  • allowedbooleanrequired

    Not older than the newest security release, so it may be installed.

  • buildsobjectrequired

    The build of each part: panel, ui and node (the streaming software).

• checked_atstring (date-time)required
• errorstringrequired

  Why the releases could not be checked, or empty.

• panelobjectrequired

  How updating the panel is going.

  • statestringrequired

    idle, requested, running, done or failed.

  • messagestringrequired

    What the server said, in plain words.

  • atstringrequired

    When it was asked or last moved (ISO 8601), or empty.

  • installedbooleanrequired

    The panel's server can update it from the dashboard (set up once on the server).

  • logstringrequired

    The end of the update's log, when it failed.

• streamingobjectrequired

  Whether the panel's own server streams too.

  • statestringrequired

    idle, requested, running, done or failed.

  • messagestringrequired

    What the server said, in plain words.

  • atstringrequired

    When it was asked or last moved (ISO 8601), or empty.

  • streamingbooleanrequired
  • domainstringrequired

    Its main streaming address.

  • addressesstring[]required

    Every address viewers may be sent to, the main one first.

  • rulestringrequired

    How each new viewer gets an address: turns, least_busy, same_viewer or random.

  • possiblebooleanrequired

    The panel's server can add or remove streaming from here.

• addressesobjectrequired

  The panel's and its dashboard's addresses and ports.

  • statestringrequired

    idle, requested, running, done or failed.

  • messagestringrequired

    What the server said, in plain words.

  • atstringrequired

    When it was asked or last moved (ISO 8601), or empty.

  • panelstringrequired

    Where players and streaming servers connect.

  • dashboardstringrequired

    Where people sign in.

  • old_panelstring[]required

    Earlier panel addresses that still work.

  • old_dashboardstring[]required

    Earlier dashboard addresses that still work.

  • panel_portintegerrequired
  • ui_portintegerrequired

    The dashboard's port.

  • stream_portintegerrequired

    The port the panel's own server streams on.

  • old_panel_portsinteger[]required
  • old_ui_portsinteger[]required
  • possiblebooleanrequired

    The addresses can be changed from here.

  • ports_possiblebooleanrequired

    The ports can be changed from here too.

  • watchedbooleanrequired

    A new address is kept only once it answers; otherwise the previous ones come back.

  • untilstringrequired

    While a change is being watched: until when (ISO 8601), else empty.

  • rolled_backbooleanrequired

    The last change was put back (message says why).

  • rescueobjectrequiredcan be null

    The rescue address, open only while the addresses change; shown to the panel's owner only. Null while it is closed.

    • portintegerrequired
    • urlstringrequired

      Empty when the server's IP address is not known.

Errors#

• 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.
• 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means