Skip to content

Connect HestiaCP servers

ClientFence creates, suspends and removes HestiaCP users through the Hestia API. You add each server once with an access key, then link your hosting plans to Hestia packages.

  1. In Hestia’s server settings, turn on the API and add the IP address of your ClientFence server to the addresses allowed to use it. See Hestia’s REST API guide.
  2. Signed in as the first admin user, open the user button at the top right, then Access Keys, and select Add Access key.
  3. Choose the billing permission set. It allows every command ClientFence uses.
  4. Select Save and copy both the access key and the secret key. Hestia does not show the secret key again.

See Hestia’s API access keys guide.

  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 Hestia opens at, such as server1.example.com. ClientFence connects to it. Required.
IP The server’s main IP address.
Server Manager Hestia Control Panel.
Access Key ID The access key.
Secret Key The secret key.
Connection Port Empty uses 8083, Hestia’s panel port.
Verify TLS Certificate Yes, unless the server uses a self-signed certificate.
Password Length Length of the passwords ClientFence makes for new accounts. Empty means 10.

The Hestia API always uses HTTPS, so Use Secure Connection has no effect.

  1. Select Test Connection (the signal icon) on the server’s row. It lists the users through the API.

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

ClientFence cannot create Hestia packages. Make each package in Hestia first, then make a hosting plan on the Hosting Plans tab (New Plan) with exactly the same name. New users and plan changes use the Hestia package of that name, with the limits set in Hestia; the limits on the hosting plan’s page are not sent.

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 the user with a user name from the domain (never starting with a digit), a new password, the client’s email and name, and the package. Then adds the domain to the user. If the domain cannot be added, the user is deleted again and the activation fails.
Suspend / unsuspend Suspends or unsuspends the user.
Cancel Deletes the user.
Change Hosting Plan Moves the user to the Hestia package with the new plan’s name.
Change Account Password Changes the user’s password. Clients can do this on their service page too.
Sync with server Not shown for HestiaCP accounts.
Change Username, Change Domain, Change IP Not supported: the action stops with the message “HestiaCP does not support …”.
Login to Control Panel (client) Opens the Hestia sign-in page, https://<Hostname>:8083/. There is no one-click sign-in.
Jump to control panel (staff) Opens the same address.

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

  • The HestiaCP server hostname is missing: fill in the Hostname.
  • Failed to connect to the HestiaCP server. Please verify your credentials and configuration: Hestia answered with an error. Check the keys, that the API is on and that the ClientFence server’s IP address is allowed.
  • Failed to … on the HestiaCP server, check the error logs: Hestia refused the command. Check that the package exists with the hosting plan’s exact name. Hestia’s return code is in Activity → System Activity.
  • The HestiaCP server returned HTTP status …: Hestia answered with an HTTP error. Check that the server is up and the Hostname, port and keys.
  • Could not connect to the HestiaCP server: check the Hostname, the Connection Port and that the firewall lets the ClientFence server reach it.

Failed order actions are listed under Orders → Failed actions. See Failed actions.