minimusdocs
Help center

Servers

Stream from the panel's own server

POST/instances/updates/streaming/

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

Installs streaming on the panel's own server, at domain (an address of its own that points at the server); domain: null stops it, and the server stops getting streams at once. Follow streaming in GET /instances/updates/. Panel operators only.

Body

  • domainstringrequiredcan be null

    The address to stream on (a bare hostname, not the panel's), or null to stop streaming.

Response

202 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 domain is not a bare hostname.
  • 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 It cannot be done now; detail says why.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means