Plesk Key Administrator

Sell Plesk licences from Blesta and have every key created, IP-bound, and kept in sync with Plesk automatically.

What it does

Selling Plesk licences usually means jumping into the Plesk partner portal by hand for every order: creating the key, copying the activation code back into a support ticket, and remembering to check on it later. Plesk Key Administrator removes that entirely. A paid order creates the licence key on Plesk the moment it is placed, the key number and activation code are stored against the service, and the whole lifecycle from provisioning through suspension, cancellation and renewal is pushed to Plesk automatically as your billing events happen. A nightly sync keeps the stored details current and flags any key Plesk reports as suspended or terminated while the service is still meant to be active.

Key features

• Automatic Licence Key Provisioning: A paid order creates the Plesk licence key immediately and stores its key number and activation code against the service, so the client has a working licence without anyone opening the Plesk partner panel.
• Sell Every Tier From One Package: Pick the licensed product per package from the full list of Plesk partner items, or attach Blesta configurable options so clients choose their own tier or add-ons at checkout.
• Optional IP Binding With Client Self-Service: Turn IP binding on for a package and clients enter the server IP at checkout; a dedicated Change IP tab lets them (or your staff) rebind the licence themselves later, without a support ticket.
• Live Licence Details: A Licence Details tab for both staff and clients shows the key number, activation code, item, status, expiration date and auto-renew state, refreshed from Plesk rather than only what was stored at order time.
• Nightly Key Sync and Drift Alerts: Every night the module refreshes stored key details for active services and records a notice for any key Plesk reports suspended or terminated while the service is still active, so a revoked licence never goes unnoticed.
• Suspend, Terminate and Upgrade Handling: Suspending a service suspends the key, reactivating restores it, cancelling terminates it, and a package change moves the service onto the new item, all pushed to Plesk automatically.
• Mock and Demo Modes: Enable Mock API to run and demo the entire module end to end with bundled sample data and no live Partner credentials, or point an account at Plesk's own hosted demo environment to trial it against their sandbox.

Contact Us

For any inquiries or support, please visit Blesta Club Support.

Installing Plesk Key Administrator

Before you start

• Blesta 6.0 or newer is required. Version 3.x of this module targets the Blesta 6 admin theme; it is not supported on Blesta 5.
• If you are on the leased (subscription) licence, the Blesta Club Subscription Manager must be installed and your subscription active. The owned and owned-source licences have no such requirement.

1. Upload the files

Upload the extension folder into your Blesta installation so it lands under your Blesta directory at:

components/modules/plesk_key_administrator/

For example, on a typical install: /var/www/html/blesta/components/modules/plesk_key_administrator/

2. Install it in Blesta

1. Log in to your Blesta admin area with a staff account that has the Modules permission (with Install access) under Settings in Manage Staff Groups.
2. Go to Settings > Company > Modules and click the Available tab.
3. Find Plesk Key Administrator in the list and click Install.

3. Configure it

1. From Settings > Company > Modules > Installed, click Manage next to Plesk Key Administrator, then add an account with your Plesk Key Administrator Partner API 3.0 username and password. If you want to try the module before you have live credentials, tick Enable Mock API instead - it runs the whole module end to end against bundled sample data, no live account needed. Ticking Demo Mode points the account at Plesk's own hosted demo environment rather than at Mock API or your live Partner account.
2. Credentials are checked against Plesk when you save the account, so a mistyped username or password is caught immediately (accounts with Mock API ticked skip this check).
3. Create a package, open its Module tab, choose the Plesk Item you want to sell, tick IP Binding if the licence should be tied to a server IP, and select the account to provision from.
4. Optionally, open the package's Welcome Email tab and click Load Sample Email to load the module's ready-made template, which delivers the key number, activation code and item to the client.
5. No cron setup is needed - a nightly Key Sync task is registered automatically when the module is installed and runs on Blesta's existing cron.

You're ready to go - see the usage guide for a walkthrough of day-to-day use.

Contact Us

If you encounter any issues during installation, feel free to contact us via Blesta Club Support.

Plesk Key Administrator by Blesta.Club - Update Guide

Follow these steps to update the Plesk Key Administrator module to the latest version.

Steps for Updating

1. Download the Latest Version

• Visit the client area to obtain the latest version of the Plesk Key Administrator.

2. Upload the Updated Files

• Upload the updated files to your Blesta installation directory:

   /var/www/html/blesta/components/modules/plesk_key_administrator/

3. Run Update in Blesta

• Log in to your Blesta admin dashboard.
• Navigate to Settings > Modules.
• Click the Update button next to the Plesk Key Administrator module.

4. Clear Cache

• After the update, navigate to Settings > System and clear the cache to apply the new changes.

Testing the Update

• Verify that the module is interacting correctly with the Plesk API after the update.

Notes for 3.0.0

• Blesta 6.0 or newer is required. Upgrade Blesta first, then upload the module files and click Update as described above. No settings change: your accounts, packages and services carry over as they are.
• All staff-facing screens (account management, Add/Edit Account, the service information panel and the License Details and Change IP tabs) now use the Blesta 6 admin theme and follow its light or dark mode. The client area is unchanged.

Notes for 2.0.0

• Security fix, review your accounts. Earlier versions accepted a Key ID from any request that reached the service form, including a client's own order. A Key ID is now accepted only from a signed-in staff member on the Add/Edit Service form, and must be the key's numeric ID. If you have been running an earlier version, check Clients > Services for services whose Key ID you did not set yourself.
• The Partner API username and password are no longer available as {module.username} / {module.password} email tags. Row meta renders decrypted into email templates, so any template that referenced them must be edited before updating. {module.demo} and {module.mock} are unchanged.
• Accounts saved while Mock API mode was enabled must be given a password when you untick it. The stored one was never authenticated against Plesk, so leaving the field blank is now refused.
• Services that were provisioned while Mock API mode was enabled are quarantined. Their Key ID came from a bundled fixture, so suspend, unsuspend, cancel, package change and Change IP refuse to act on them once the account is switched to live rather than sending a demo ID to your real Partner account. Delete those demo services, or re-tick Mock API mode to work with them.
• Configurable options named item must be sold as a Select option. An override that is not one of the license constants the module offers is now ignored and the package's own Item is used.
• The Key Sync cron task registration is repaired on update. Duplicate task runs left behind by earlier updates are removed, so the nightly sync runs once per night rather than once per surplus run row.
• Requests to Plesk now time out after 60 seconds instead of hanging, so an unreachable Partner API no longer stalls a client's Services page or the nightly cron.

Notes for 1.1.0

• The account password is no longer shown on the Edit Account form. Leave the Password field blank to keep the stored password; enter a value only to replace it.
• Saving an account now authenticates the credentials against the Partner API, so an account with wrong credentials can no longer be saved. Accounts with Enable Mock API ticked skip this check.
• Service tabs were renamed. Any bookmarked tab links need to be re-opened from the service page.

Contact Us

For support or update-related issues, contact Blesta Club Support.

Plesk Key Administrator by Blesta.Club - Usage Guide

This guide provides instructions on how to use the Plesk Key Administrator to manage Plesk licenses directly within Blesta.

Module Capabilities

The Plesk Key Administrator allows you to assign, manage, and bill Plesk licenses using the Plesk Partner API.

Key Features

• License Management

  • Assign licenses for different Plesk editions (Web Admin, Web Pro, Web Host) to clients.
  • Automate the provisioning and configuration of licenses via the Plesk API.

• Add-On Items

  • Extras such as WordPress Toolkit, CloudLinux, DNSSEC and language packs are Plesk items in their own right. Sell one as a package of its own, or configure it as an add-on package attached to a parent license package, and the module links the two keys together on Plesk automatically.

• Billing Integration

  • Licence pricing and renewal follow the package's own Blesta pricing and billing cycle, the same as any other product you sell.

• Mock API Mode

  • Tick Enable Mock API on an account to serve bundled fixture responses instead of contacting Plesk. Ordering, provisioning, the service tabs, suspension and cancellation all work end to end with no live credentials, which makes it ideal for demos and staging.

• Module Logging

  • Every request the module sends to Plesk, and the response it receives, is recorded under Tools > Logs > Module. Credential values are replaced with *** before anything is written.

• Configurable Options

  • A package's Item and IP Binding can be overridden per service by configurable options named item and ip_binding.
  • Sell Item as a Select option, never as Text. A Select option is the only kind where you decide which licences are on offer and what each one costs; a Text option lets the client type the constant themselves, so they can choose a licence they have not paid for. The module rejects any override that is not one of the constants it offers and falls back to the package's own Item, but that is a safety net, not pricing control.
  • ip_binding accepts only true or false.

Available License Options

The module supports the following license options:

Plesk 12/Onyx/Obsidian Keys (Monthly Lease):

1. Plesk Web Admin Edition (PLESK-12-WEB-ADMIN-1M)
2. Plesk for VPS Web Admin Edition (PLESK-12-VPS-WEB-ADMIN-1M)
3. Plesk Web Pro Edition (PLESK-12-WEB-PRO-1M)
4. Plesk for VPS Web Pro Edition (PLESK-12-VPS-WEB-PRO-1M)
5. Plesk Web Pro Edition with CloudLinux (PLESK-12-WEB-PRO-CLNX-1M)
6. Plesk for VPS Web Pro Edition with CloudLinux (PLESK-12-VPS-WEB-PRO-CLNX-1M)
7. Plesk Web Host Edition (PLESK-12-WEB-HOST-1M)
8. Plesk for VPS Web Host Edition (PLESK-12-VPS-WEB-HOST-1M)
9. Plesk Web Host Edition with CloudLinux (PLESK-12-WEB-HOST-CLNX-1M)
10. Plesk for VPS Web Host Edition with CloudLinux (PLESK-12-VPS-WEB-HOST-CLNX-1M)

Purchased Keys:

1. Plesk Onyx Web Admin Edition (PLESK-ONYX-WEB-ADMIN)
2. Plesk Onyx Web Pro Edition (PLESK-ONYX-WEB-PRO)
3. Plesk Onyx for VPS Web Pro Edition (PLESK-ONYX-VPS-WEB-PRO)
4. Plesk Onyx Web Host Edition (PLESK-ONYX-WEB-HOST)
5. Plesk Onyx for VPS Web Host Edition (PLESK-ONYX-VPS-WEB-HOST)

Add-Ons:

1. Plesk Multi Server (ADD-PLESK-MS-1M)
2. Docker Remote Node Management (ADD-DOCKER-REMOTE-NODE-MGMT-1M)
3. DNSSEC (ADD-DNSSEC-1M)
4. WordPress Toolkit (ADD-PLESK-WORDPRESS-TOOLKIT-1M)
5. 1 Language Pack for Plesk (ADD-PLESK-1-LANGUAGE-PACK-1M)

Admin View

1. Assigning a license

   • Licenses are provisioned the normal Blesta way: order the package for a client, or from the client's profile go to Services and add or edit a service using a package that sells a Plesk item.
   • The Key ID field on the staff Add/Edit Service form attaches the service to a key that already exists in your Partner account, by entering its numeric ID. Leave it blank and the module creates a new key on Plesk instead. It is accepted only from a signed-in staff member; a Key ID submitted from anywhere else, including the client order form, is discarded.
   • If the package has IP Binding on, an IP Address field is shown alongside it for the server the key will be bound to.

2. Add-on items

   • Sell extras such as WordPress Toolkit, CloudLinux or DNSSEC as their own package, configured in Blesta as an add-on to the parent license package. When a client has both, the module attaches the add-on's key to the parent license's key on Plesk automatically.

3. Billing

   • Licenses renew and bill the same as any other Blesta service, on the package's own pricing and billing cycle.

Client View

• Manage Licenses
  • Clients can view and manage their Plesk licenses directly from their Blesta client dashboard.
  • The License Details tab shows the key number, activation code, item, status, creation date, expiration date, auto-renew state and (for IP-bound packages) IP binding and the bound address. When the Partner API cannot be reached, the details stored at provisioning time are shown instead of blank fields.
  • The Change IP tab is available for IP-bound packages and rebinds the key to a new IPv4 or IPv6 address.
  • The license details can also be delivered in the welcome email: open the package, go to the Welcome Email tab, click Load Sample Email to load the module's sample, and save. Packages that skip this step send Blesta's generic service creation email.

Contact Us

For any inquiries, please contact Blesta Club Support.