minimusdocs
Help center

Servers

Get the install command for a new server

POST/instances/bootstrap/

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

Makes a one-time registration token for a new streaming server, and the command to run on it, which installs it and adds it here. The token works once, for ttl_minutes (60 by default), and is shown only in this answer. Panel operators only.

Body

  • instance_idstring
  • namestring
  • domainstring

    The new server's public address, such as node1.example.com. Leave it empty to set up its web address yourself.

  • ttl_minutesinteger

    Default: 60

  • stream_portinteger

    The port the new server streams on. 443 is recommended: keep it unless something else there uses it.

    Default: 443

  • replacesstring (uuid)

    A server of a panel this one was moved from (Settings → Move from another panel). The node installed there serves that server's films and episodes where they are.

  • max_streamsinteger

    The most streams the server runs at once.

    Default: 5000

Response

201 OK

  • instance_idstringrequired
  • namestringrequired
  • expires_atstring (date-time)required
  • registration_tokenstringrequired
  • install_commandstringrequired

Errors

  • 400 The address is taken, or replaces is not a moved server.
  • 401 No credential, or one that is wrong, expired or revoked.
  • 402 The license allows no more servers.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 409 instance_id is already used.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means