minimusdocs
Help center

License

Get the license status

GET/licensing/status/

read Read: looks, changes nothing. Scopes

The license's holder, plan, server limit, features and expiry; whether streaming is allowed right now and, if not, why (streaming_allowed, problem); and when the license server last confirmed it (server_check). needs_setup is true while no license is installed. The license itself is never returned. Panel operators only.

Response

200 OK

  • 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

  • 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.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means