minimusdocs
Help center

Servers

Set the panel server's streaming addresses

PUT/instances/updates/streaming/addresses/

manage Delete and money: deletes, credits, servers or panel settings. Scopes

The addresses viewers are sent to on the panel's own server, its main one first, and how each new viewer gets one (rule). Each must point at the server; they work as soon as they are saved. Panel operators only.

Body

  • addressesstring[]required

    The names viewers are sent to, the main one first.

  • rulestring

    How each new viewer gets one: take turns, least busy, same per viewer, at random.

    • turns - turns
    • least_busy - least_busy
    • same_viewer - same_viewer
    • random - random

    Default: "turns"

Response

200 OK

  • 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.

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.
  • 409 The panel's own server does not stream.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means