pem.installPleskLicense

This method is supported by POA starting from version 2.6.5

This method allows to install Parallels Plesk Panel license or license of service managed by Parallels Plesk Panel.

Name

Type

Short Description

subscription_id

int

The ID of the Subscription, which the Parallels Plesk Panel in VPS is provisioned under.

license

base64

The content of the license.

[async]

boolean

Whether to perform license installation asynchronously. There are the following options:

  • 0 - Install a license synchronously.
  • 1 - Install a license asynchronously.

If parameter is not set, 0 (false) value is used by default.

Note: If POA is integrated with PBA and the method is executed asynchronously, then POA notifies PBA about the result of installing a license using PBA Public API (POA does not check that PBA is a caller of this method). If you wish to install a license using this method directly (not through PBA Control Panel), execute it synchronously (async = 0).

[is_addon]

boolean

Defines the type of the license:

  • 0 - Parallels Plesk Panel license.
  • 1 - License of service managed by Parallels Plesk Panel.

If parameter is not set, 0 (false) value is used by default.

This method has no output parameters.