minimusdocs
Help center

Servers

Change the panel's addresses and ports

PUT/instances/updates/addresses/

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

New addresses and ports for the panel, its dashboard and the streaming on its own server (a port left out stays as it is). The server changes them once they lead to it, and keeps the present ones working except those in remove and remove_ports; follow addresses in GET /instances/updates/. Panel operators only.

Body

  • panelstringrequired

    Where players and streaming servers connect.

  • dashboardstring

    Where people sign in; empty when the panel has no dashboard.

  • removestring[]

    Old addresses that stop working.

  • panel_portinteger

    The panel's port. Unset: the present one.

  • ui_portinteger

    The dashboard's port. Unset: the present one.

  • stream_portinteger

    The port this server streams on. Unset: the present one.

  • remove_portsinteger[]

    Old panel or dashboard ports that stop working.

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.

  • 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

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