Plesk comes with a limited trial license key which is installed automatically . Therefore, to fully use Plesk as you need, you should obtain a license key from Plesk or one of its resellers and install it to your Plesk.

Once you purchase a Plesk license key at the Plesk online store, you will receive an activation e-mail with your activation code and a license key file. You can install a Plesk license key either by entering the activation code or by uploading the file from this e-mail. In both cases, you should use the lic_install operation. This operation is also used for installing additional license keys that allow using Plesk additional features (add-ons) like Acronis True Image, Kaspersky Antivirus, and so on.

Request Packet Structure

A request XML packet installing license key to Plesk contains the lic_install operation node:

<packet>
  <server>
    <lic_install>
      ...
    </lic_install>
  </server>
</packet>

The lic_install node is presented by complex type LicenseInstallType (server_input.xsd) and structured as follows:

image 70840.gif

Note: The interactive schema navigator for all request packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_input.svg.

  • The license node is required, in case you install a key using a license key file. It contains the license key data. Data type: base64.
  • The activation-code node is required, in case you install a key using an activation code. The node is available in XML API 1.6.3.5 and later. It specifies an activation code. Data type: string.
  • The additional_key node is optional. It specifies if the key that will be installed is an additional key. Data type: none.

Note: When creating request packets, put nodes and elements in the order they follow in the packet structure.

Response Packet Structure

The lic_install node of the response packet is structured as follows:

image 36964

Note: The interactive schema navigator for all response packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_output.svg.

  • The result node is required. It wraps the result of the lic_install operation. Data type: resultType (common.xsd).
  • The status node is required. It returns the execution status of the lic_install operation defining whether installing key has been successfully started or not. Data type: string. Allowed values: ok | error.
  • The errcode node is optional. It returns the error code when the lic_install operation fails. Data type: unsignedInt.
  • The errtext node is optional. It returns the error message if the lic_install operation fails. Data type: string.

Samples

This packet installs a license key using a key file (the key content is greatly reduced).

<packet>
<server>
<lic_install>   <license>/RjdfLic1RwpNPkEnLlxNJkJCPzNDWSRDOyVeJDI/MSo1RlFEMD4+VTEzKTk3S0pfVjFOJTZFXzMpTEVPQC5JRjdUR0RZCk0hMSJYOzYhVFxPI14jTFJPRSlaRFI0VjZWPEYiT1s5T0opJV8+NCMnUigvQ1o7K0U+QEtbISc1MlMqLV0KTSorUDVfMzxHNUkrSksxWzZVNVZJXTc5T18xQVNNNzRXWTo3WVkmW0I/J2AnYC4iJTlTP1grSCdYS0E+RApNPVteRk43RCNAVFpVO0dBO1hZMjo+K0pQNEsiLj5UUDQlLDA7XyVZIVo/QypGJiJcW1FbJF1fVVxUJy5ECk1HXCpSUzwtUVYoJzwsVV47MT5bJD8wWlgyYCo/KTM0QUJFMmAuOjc7QypMWylfQiFVP05PRj05LCY5SkgKTVRTWE9cRi84OUgxJDpgLl5RPEtPPkE4RCUtXU06NixHLi1ZL0ZBVSkyVkBVUCgiN0YrKyoyXTJMJ08qVwpNIk4lOyFeLFwmIiQ4NkBgMUEmTDRcWDdJKihZTEMhTENOJEMiKV0wIzkkSU4qMTEzO1BIJjo4K0U3LzU6Ck0wPCNTUytONjAhQEFROCFbUDI5OktVLlEsMlY9ND1gSjpgJVMjLS4tVzsrRzpAME8yVTpLVmAiT1NHLFAKTVU0SSowNVo1IShEWipAO10tRlsxQldVSkZSKDcyPjpWLik5I0YzWD0yVTs9NTlNL1dASyglXk5YN1U4UgpNTV8sXD0tRTQuLkBFMVk2I0REUCItXyVMNlRPRkEyTEA7Pl9QO10jUSI6I1tNIzVRU0VZVE1HWDInIzk4Ck1XRUNPVz5CSFUjUSo4K0IvOFlDWSNTLydXSls7KD9VTD8+WzUqQEA5Uic0S1BMJSowOk9fQ0QvQThUVCEKTT1AKiJFKztAKCFXNl9ORDhUVlleOCU5JS8rJzc+JEZUXigzMDs4PDtbNkUpPD8vUiJAREQoTkxUPlQ2JgpNVFdbVz9bT10mVy5FVEkyXD5MPSIkMkRVVipKWTolXVhRTzkoM1tLLSJRJFlXNTRTYEBNWy1UUV09K04wCk1SVWBbLyckXj5KXjsnUzgyRzE3QVUlWilXX0ZCX1BGMkRMSThHXjZBWE5FTUBEMjBgRTomVTpVLy1WRCQKTVtWUyQ+XDcsRUA+XU0hXz4pKFxBJ1JCNUQ6XCEnQjoyPFw</license>
</lic_install>
</server>
</packet>

Response:

<packet version="1.6.7.0">
<server>
<lic_install>
   <result>
      <status>ok</status>
   </result>
</lic_install>
</server>
</packet>

This packet installs a license key using an activation code.

<packet>
<server>
<lic_install>
   <activation-code>AB1C23-4DEF56-7GHI89-JK1L23-MNP456</activation-code>
</lic_install>
</server>
</packet>

This request packet installs additional license key using a key file (the key content is greatly reduced).

<packet>
<server>
<lic_install> <license>LS0tLS1CRUdJTiBQTEVTSyBBRERJVElPTkFMIEtFWS0tLS0tCmtleV9udW1iZXI9J1BMU0swMDA0MTEzNjAwMDEnCmh3aWQ9J25vdC1yZXF1aXJlZCcKa2V5PSc3YzAzZTFlZDhjNjEyMTNhZDZjZmM1NjFmNjc5YTE4MicKbGltX2RhdGU9MApuYW1lPSdzYXBwLVBQV1NFLTEnCi0tLS0tQkVHSU4gUExFU0sgQURESVRJT05BTCBLRVkgU0lHTkFUVVJFLS0tLS0KOGM2MGZmZjYxZjUyMWVmYTdlOWZjNDZhNTAzZGJmNDVmZDEyZGZiMWUxY2JlMmYwMGEwZTVhZmQwMDAzMGE4ZjUyOTk5ZGZmMjNjOGIyZGY2NjRkNTQ2ZWNiYmE1OTFmZGQyNjdkNWI5OWM1NTgzZTg2N2RkNjNlMmU1ZjMxMzlmOTM3NGNiNTI4MDRhNzE3ZTAzN2Y4MDQzY2QyODczMDgyMTg1N2QyN2Y2M2VmYjdjNzEzZGE2MDRlYzFlZGRhMWQzYzQ5ODlkZmM1MzU2ODJlNWQxZGMzZjcxM2NlZTlmNGIzZDRlY2M4Y2MwMWVlNmMyMzU2Y2I1ODlhMDJkZTRkNjYzZGViNjZlMGRkMDM5MDk3NTEwODk4NDQ3ODJjMGZkMDVjZWViNmYyYmFlNTk2NjczODg1MGRkNmRjYjY5YzEzMmFhYzg0ZWE3MDAwNGViYjUxMjcwNjViMjA2MDQwYmJmNGY2OTdlYTc5OWM2YTcxODhmNTY1MjkwOTA2YzMyNmYxYmM3OWUwMmVlMzk2MzY4MjgwZWEyMzRiODk5NzAwMmY3OWFlZjMyMWMwNjE3OTBmNjIyOGVhMTBjOGQyOTlhM2JhMjViMjk5NGM5ZTg1NjFlZDVmNDBiODQyYWMzMTYxZGE2OWZlOWM2ZDIzZGUzNWJlMTExNjk2MmIKLS0tLS1FTkQgUExFU0sgQURESVRJT05BTCBLRVktLS0tLQ==</license>
  <additional_key/>
</lic_install>
</server>
</packet>