Installing Additional License Keys

Plesk functionality can be increased by using additional features (add-ons) like Acronis True Image, Kaspersky Antivirus, and so on. These add-ons require an additional license keys that can be ordered at any time. To install add-ons license keys:

  1. Buy desired add-ons at the Plesk online store.
  2. Wait for the confirmation e-mail. Once your order is processed, you will receive e-mail saying that add-on keys are linked to your license key.
  3. Install the add-on keys with the license-retrieve-keys operation. You have no need to explicitly specify them, as the operation automatically installs all additional keys linked to your Plesk license key.

In this chapter:

Request Packet

Response Packet Structure

Samples

 
Request Packet

The license-retrieve-keys operation is used for the additional keys installation.

A request XML packet (server_input.xsd) installing additional keys:

<packet>
<server>
   <license-retrieve-keys/>
</server>
</packet>

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.

 
Response Packet Structure

The license-retrieve-keys node of the output XML packet is of complex type (server_output.xsd) which has the following presentation:

license-retrieve-keys response 1633

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.

  • result, required.
    It wraps the result of the license-retrieve-keys operation. Data type: resultType (common.xsd).
  • status, required.
    It returns the execution status of the operation. Data type: string. Allowed values: ok | error.
  • errcode, required if the operation fails.
    It returns error code. Data type: unsignedInt.
  • errtext, required if the operation fails.
    Returns error message. Data type: string.
 
Samples

A request XML packet (server_input.xsd) installing additional keys:

<packet>
<server>
   <license-retrieve-keys/>
</server>
</packet>

Response:

<packet>
  <server>
    <license-retrieve-keys>
      <result>
        <status>ok</status>
      </result>
    </license-retrieve-keys>
  </server>
</packet>