License

License state, activation and check-ins. While the panel is locked or read-only, other endpoints answer 402 LICENSE_REQUIRED.

5 endpoints

License state

GET/api/v1/license

Admins get the full state: edition, servers used and allowed, lease end, last check-in and errors. Other users get whether the panel is usable or read-only.

Example

curl "https://panel.example.com/api/v1/license" \
  -H "Authorization: Bearer $TRIXOS_TOKEN"

Release the license

DELETE/api/v1/license

Admin only

Releases it on the license server, for example before moving to a new installation. This installation locks.

Example

curl -X DELETE "https://panel.example.com/api/v1/license" \
  -H "Authorization: Bearer $TRIXOS_TOKEN"

Activate a license key

POST/api/v1/license/activate

Admin only

Pro or Enterprise. A key that is active on another installation moves here.

Request body

keystringrequired
min. 10 chars, max. 64 chars

Example

curl -X POST "https://panel.example.com/api/v1/license/activate" \
  -H "Authorization: Bearer $TRIXOS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key":"TRX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"}'

Activate the Community Edition

POST/api/v1/license/community

Admin only

Free for up to 10 servers.

Request body

emailstringrequired
email, max. 254 chars, pattern ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Example

curl -X POST "https://panel.example.com/api/v1/license/community" \
  -H "Authorization: Bearer $TRIXOS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]"}'

Check in now

POST/api/v1/license/check

Admin only

Renews the lease from the license server right away.

Example

curl -X POST "https://panel.example.com/api/v1/license/check" \
  -H "Authorization: Bearer $TRIXOS_TOKEN"