Page tree
Skip to end of metadata
Go to start of metadata

Description

This function verifies the system's license status with cPanel, Inc.'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.

Examples  


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/run_cpkeyclt?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/run_cpkeyclt?api.version=1
 Command Line
whmapi1 run_cpkeyclt

Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "run_cpkeyclt"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>run_cpkeyclt</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Return

This function only returns metadata.