Skip to content

Connect Plesk servers

ClientFence creates Plesk customers with one subscription each, and suspends and removes them, through the Plesk XML API. You add each server once, then link your hosting plans to Plesk service plans.

  1. ClientFence signs in to the XML API with the Plesk administrator login and password. Use an administrator account.
  2. If the API is limited to some addresses (allowedIPs in the [api] section of panel.ini), add the IP address of your ClientFence server. See Plesk’s Restricting Access via XML API.
  3. Make a service plan for each hosting plan you sell (see below).
  1. Go to System → Hosting Plans and Servers, stay on the Hosting Servers tab and select New Server.
  2. Fill in the form and select Add Server:
Field What to enter
Name Any name you know the server by.
Hostname The address Plesk opens at, such as plesk.example.com. ClientFence connects to it.
IP A shared IP address in Plesk. New subscriptions are made on it.
Server Manager Plesk.
Username / Password The Plesk administrator login.
Connection Port Empty uses 8443.
Use Secure Connection Yes. It sets the address of the control panel links; the API always uses HTTPS.
Password Length Length of the passwords ClientFence makes for new accounts. Empty means 10.

Verify TLS Certificate has no effect for Plesk: the API connection does not check the certificate.

  1. Select Test Connection (the signal icon) on the server’s row. It reads the server’s statistics from Plesk.

On the server’s edit page, Users Prefix adds a prefix to the logins ClientFence makes. Saved credentials are never shown again. To change one, enter a new value and save.

Make a hosting plan on the Hosting Plans tab (New Plan) with exactly the same name as the Plesk service plan. A new subscription is based on the service plan of that name, and ClientFence also sends the hosting plan’s own limits:

Hosting plan field Plesk limit
Disk Quota, Bandwidth (MB) Disk space, traffic
Maximum Databases Databases
Maximum Email Accounts Mailboxes
Maximum Subdomains Subdomains
Maximum FTP Accounts Additional FTP accounts
Maximum Addon Domains Domains (sites)

Enter a number or unlimited in each limit. An empty limit is not sent, so Plesk keeps its own value. Under Hosting Plan Additional Parameters you can add nemailml (mailing lists) and cron, aftp, ssh and spam set to 1 to give the customer those rights.

Then choose the server and the hosting plan in the product’s Configuration tab, under Hosting Settings. See Products.

Action What happens
Order activated Creates a customer (or a reseller, with Reseller Hosting) with the client’s contact details, then a subscription for the domain on the server’s IP. A reseller gets a free dedicated IP when Plesk has one.
Suspend / unsuspend Suspends or activates the customer (or reseller).
Cancel Deletes the customer (or reseller) in Plesk.
Change Hosting Plan Updates the customer’s (or reseller’s) contact details and the subscription’s limits and rights. The subscription stays on its Plesk service plan.
Change Account Password Changes the customer’s (or reseller’s) password. Clients can do this on their service page too.
Change Domain Renames the subscription’s domain.
Change Username, Change IP Not supported: the action stops with the message “Plesk does not support …”.
Sync with server Not shown for Plesk accounts.
Login to Control Panel (client) Opens Plesk signed in as the customer. A reseller gets the Plesk sign-in page.
Jump to control panel (staff) Opens the Plesk sign-in page, https://<Hostname>:8443 with the default port.

A new password or domain reaches Plesk on active, suspended and expired orders. While an order is not yet set up or is canceled, the change is saved in ClientFence only.

  • Plesk does not support …: the action is not available for Plesk; do it in Plesk.
  • Failed to connect to the Plesk server. Please verify your credentials and configuration: check the Hostname, Username and Password.
  • Can’t modify client: Plesk refused the customer update during a plan change.
  • Other errors show Plesk’s own message, or the connection error (refused, timed out): then check the Connection Port and that Plesk’s firewall lets the ClientFence server reach it.

Failed order actions are listed under Orders → Failed actions with the error. See Failed actions.