KyPanelDocs
/

API reference

License

The server's KyPanel license.

License status

GET/api/v1/license

Who
root
API tokens
admin token area: server
Operation
licenseInfo · ky call licenseInfo

Responses

  • 200 OK
    Body
    FieldType
    grace_ends_atinteger
    ip alwaysstring
    last_checkin_atinteger
    last_checkin_errorstring
    lease_expires_atinteger
    lease_issued_atinteger
    license_idstring
    license_server alwaysstring
    next_checkin_atinteger
    planstring
    read_only alwaysboolean
    readonly_sinceinteger
    register_url alwaysstring
    server_pub alwaysstring
    status alwaysstring
    trial_ends_atinteger
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
  • 503 Service Unavailable: license-off

Check the license now

POST/api/v1/license/check

Who
root
API tokens
admin token area: server
Operation
licenseCheck · ky call licenseCheck

Responses

  • 200 OK
    Body
    FieldType
    grace_ends_atinteger
    ip alwaysstring
    last_checkin_atinteger
    last_checkin_errorstring
    lease_expires_atinteger
    lease_issued_atinteger
    license_idstring
    license_server alwaysstring
    next_checkin_atinteger
    planstring
    read_only alwaysboolean
    readonly_sinceinteger
    register_url alwaysstring
    server_pub alwaysstring
    status alwaysstring
    trial_ends_atinteger
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
  • 429 Too Many Requests: too-soon
  • 503 Service Unavailable: license-off