All documentation

Running Plesk with Hostinvo

Connect a Plesk server, link products to its service plans, create hosting accounts and manage them: suspend, unsuspend, terminate and sync.

Once a Plesk server is connected, Hostinvo creates and manages your clients' hosting on it for you. This page takes you from connecting the server to running the module commands, and explains the messages you may see on the way.

1. Connect the Plesk server

  1. 1

    Create an API key on the Plesk server

    Sign in to the Plesk server over SSH and run the command below. It prints a key that works only for the Plesk API; you can remove it at any time without touching the admin password.

    plesk bin secret_key --create -description "Hostinvo"
  2. 2

    Add the server in Hostinvo

    Servers → Add server. Enter a name and the hostname, choose Plesk as the panel type, choose "Plesk API key (recommended)" under How Hostinvo signs in to Plesk, and paste the key. Leave Panel address and Panel port empty unless your panel is not at https://hostname:8443.

  3. 3

    Test the connection

    Save, then use Test connection on the server page. If it fails, the message says why: a refused key, a blocked IP in Plesk's API access settings, or a wrong address.

TipKeep "Verify SSL certificates" on when the panel has a valid certificate. Turn it off only for a server that still uses Plesk's self-signed certificate.

2. Link each product to a Plesk service plan

  • Open the product, then Module settings: choose Plesk as the Provisioning module and your server as the Linked server.
  • Panel package name is the service plan's name exactly as it appears in Plesk (for example Starter).
  • The plan doesn't have to exist yet: fill in the limits under Plesk service plan and press Create plan on Plesk. Hostinvo creates the plan, or updates it if it already exists.
  • Under Automation, choose when the account is created: Immediately, After first payment, or Manual.

3. Create the hosting account

With automation on, the account is created when the order is paid or accepted. You can also press Create account on the service page (Clients → client → Services → the service).

In PleskWhat Hostinvo creates
CustomerOne Plesk customer per Hostinvo client, with the client's name, company and email, and a login that starts with hv. A client's later services go under the same customer.
SubscriptionNamed after the service's domain, on the product's service plan, owned by that customer.
LoginThe service's username and password, shown on the service page, open the client's hosting on Plesk.
TipIf Plesk refuses to create the customer, the subscription is still created, under the server's admin, so the order isn't blocked.

4. The module commands

Module Commands on the service page always shows all six commands. The ones that don't fit the service's state are greyed out; hover over one to see why.

CommandWhat it does in PleskAvailable when
Create accountCreates the customer (first time) and the subscription.The service has no account on Plesk yet.
Suspend accountSuspends the subscription: its sites, mail and logins stop.The service is active.
Unsuspend accountTurns the subscription back on.The service is suspended.
Terminate accountRemoves the subscription and its data from Plesk. This cannot be undone.The service is active or suspended. Hostinvo asks you to confirm.
Change packageMoves the subscription to another service plan.The service is active.
Reset passwordSets a new password for the hosting login.The service is active.

Sync (the refresh icon) reads the subscription's status and usage (disk, traffic, mailboxes, databases) from Plesk. Usage is also re-synced on its own every hour.

NoteOn a Plesk server the service status follows the commands, so the status field is locked. Don't set a service to Active by hand: Active means an account exists on Plesk. Use Create account instead.

5. The queue: "waiting in the queue" and Send again

Every command runs in the background through the queue worker. While one is waiting, the service page shows "… is waiting in the queue" and the other commands pause. It normally finishes within seconds; refresh the page to see the result. Every result also appears as a pop-up message and in the notification bell.

  • After three minutes a waiting command shows a blue Send again button: press it to queue the command again.
  • If commands keep waiting, the queue worker container is not running. On your own server, check it with the commands below.

Is the queue worker running, and what did it last do?

docker ps --filter name=queue --format '{{.Names}} {{.Status}}'
docker logs --since 10m hostinvo-queue-worker-1 2>&1 | tail -20

6. A subscription deleted on Plesk

If someone removes a subscription directly in Plesk, Hostinvo still thinks the account exists. The next command or Sync finds it missing: it fails once with "The account no longer exists on the panel", and Hostinvo unlinks the service. Create account then becomes available again, and pressing it creates the subscription anew with the same login.

7. Orders

If an order's activation failed (for example the server refused the plan), fix the cause and press Create account on the service page. Once the account exists, the order line turns Active by itself and the order completes; you don't need to retry the order.

Troubleshooting

MessageWhat to do
Create account is greyed outThe service already has an account on Plesk. If it was deleted on Plesk, press Sync once: Hostinvo unlinks it and Create account opens.
… is waiting in the queue (for minutes)Press Send again. If it stays, start the queue worker (section 5).
Domain '…' does not belong to any customerPlesk has no subscription by that name. Press Sync: Hostinvo unlinks the service so you can create the account again.
The account no longer exists on the panelExpected after a subscription was deleted on Plesk. Press Create account.
Active needs an account on the panelYou tried to set Active by hand. Use Create account instead.
HTTP 401 / did not accept the sign-inThe API key is wrong or was removed. Create a new key (section 1) and save it on the server page.
HTTP 403The key lacks permission, or Hostinvo's IP isn't allowed in Plesk → Tools & Settings → Remote API.