License

Panel license status.

4 endpoints

GET /api/license

Get License

Read the panel's license state: status, days left, limits and usage.

Any admin

Response 200 Successful Response · LicenseState

Response fields

Field	Type	Description
status	string
locked	boolean
customer	string
expires	integer
activated	integer
days_left	integer
grace_until	integer
limits	object
usage	object
message	string
message_at	integer
key	string
install_id	string
last_check	integer
last_attempt	integer
last_error	string
has_key	boolean

{
  "status": "string",
  "locked": false,
  "customer": "",
  "expires": 0,
  "activated": 0,
  "days_left": 0,
  "grace_until": 0,
  "limits": {},
  "usage": {},
  "message": "",
  "message_at": 0,
  "key": "string",
  "install_id": "string",
  "last_check": 0,
  "last_attempt": 0,
  "last_error": "string",
  "has_key": false
}

Errors: 401 Unauthorized

curl -X GET 'https://YOUR-PANEL/api/license' \
  -H 'Authorization: Bearer $TOKEN'

POST /api/license/activate

Activate

bind a license key to this server (an empty key: the one saved here again)

Sudo admin only

Request body application/json · ActivateBody

Field	Type	Required	Description
key	string	no

{
  "key": ""
}

Response 200 Successful Response · LicenseState

Response fields

Field	Type	Description
status	string
locked	boolean
customer	string
expires	integer
activated	integer
days_left	integer
grace_until	integer
limits	object
usage	object
message	string
message_at	integer
key	string
install_id	string
last_check	integer
last_attempt	integer
last_error	string
has_key	boolean

{
  "status": "string",
  "locked": false,
  "customer": "",
  "expires": 0,
  "activated": 0,
  "days_left": 0,
  "grace_until": 0,
  "limits": {},
  "usage": {},
  "message": "",
  "message_at": 0,
  "key": "string",
  "install_id": "string",
  "last_check": 0,
  "last_attempt": 0,
  "last_error": "string",
  "has_key": false
}

Errors: 401 Unauthorized

curl -X POST 'https://YOUR-PANEL/api/license/activate' \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"key": ""}'

POST /api/license/check

Check Now

ask the license server now (after a renewal, a change of limits)

Sudo admin only

Response 200 Successful Response · LicenseState

Response fields

Field	Type	Description
status	string
locked	boolean
customer	string
expires	integer
activated	integer
days_left	integer
grace_until	integer
limits	object
usage	object
message	string
message_at	integer
key	string
install_id	string
last_check	integer
last_attempt	integer
last_error	string
has_key	boolean

{
  "status": "string",
  "locked": false,
  "customer": "",
  "expires": 0,
  "activated": 0,
  "days_left": 0,
  "grace_until": 0,
  "limits": {},
  "usage": {},
  "message": "",
  "message_at": 0,
  "key": "string",
  "install_id": "string",
  "last_check": 0,
  "last_attempt": 0,
  "last_error": "string",
  "has_key": false
}

Errors: 401 Unauthorized

curl -X POST 'https://YOUR-PANEL/api/license/check' \
  -H 'Authorization: Bearer $TOKEN'

POST /api/license/dismiss-message

Dismiss Message

any admin can dismiss the seller's message once they've read it

Any admin

Response 200 Successful Response

Errors: 401 Unauthorized

curl -X POST 'https://YOUR-PANEL/api/license/dismiss-message' \
  -H 'Authorization: Bearer $TOKEN'