Return server's cPanel license status

This function verifies the system's license status with cPanel, L.L.C.'s licensing servers. To do this, the function runs the /usr/local/cpanel/cpkeyclt script.

For more information about this script and potential license problems, read our Installation Guide - Troubleshoot Your Installation documentation.

Authorizations:

Responses

Response Schema: application/json
object

Request samples

whmapi1 --output=jsonpretty \
  run_cpkeyclt

Response samples

Content type
application/json
{
  • "metadata": {
    • "command": "run_cpkeyclt",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}