minimusdocs
Help center

License

Install or replace the license

POST/licensing/upload/

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

Send the license as JSON {"token": "…"}, or its file as file in a multipart form. The panel checks it, installs it and has the license server confirm it; streaming starts once it has. Superusers only.

Body

  • tokenstring

    The license text you received.

  • filestring (binary)

    The license file, instead of token.

Response

200 OK

  • detailstringrequired

    The holder, plan and server limit accepted.

  • licenseobjectrequired

    The panel's license, as the License page shows it. The license itself is never returned.

    • needs_setupbooleanrequiredread-only
    • customer_namestringrequiredread-only
    • planstringrequiredread-only
    • max_serversintegerrequiredread-only
    • featuresanyrequiredread-only
    • expires_atstring (date-time)requiredread-onlycan be null
    • is_expiredbooleanrequiredread-only

      Whether the license's expiry date has passed.

    • days_remainingintegerrequiredread-onlycan be null

      Whole days left; negative once expired, null when there is no expiry.

    • jtistringrequiredread-only
    • last_status_okbooleanrequiredread-only
    • last_status_reasonstringrequiredread-only
    • last_verified_atstring (date-time)requiredread-onlycan be null
    • activated_bystringrequiredread-only
    • updated_atstring (date-time)requiredread-only
    • streaming_allowedbooleanrequiredread-only
    • problemstringrequiredread-only
    • server_checkobjectrequiredread-only
      • confirmed_atstring (date-time)requiredcan be null
      • lease_expires_atstring (date-time)requiredread-onlycan be null

        When streaming stops unless the panel reaches the license server again.

      • checked_atstring (date-time)requiredcan be null
      • errorstringrequired

Errors

  • 400 License rejected: its signature, expiry or issuer is wrong.
  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 Only a superuser can change the panel license.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means