Skip to content

AdminBolt for Upmind ​

AdminBolt for Upmind is a provision provider for Upmind's shared-hosting category that connects Upmind to the AdminBolt hosting control panel. It creates and manages AdminBolt hosting accounts from Upmind, reports their usage, and returns single sign-on links to the panel.

What it does ​

  • Provisioning - create accounts, read account details, suspend, unsuspend, and terminate.
  • Changes - change the hosting plan and the account password.
  • Usage - report disk, bandwidth, and mailbox usage for an account.
  • Single sign-on - open the panel for the client with a one-time login link.
  • Reseller accounts - with a reseller's key pair, accounts are created under that reseller.

The provider does not support granting or revoking reseller privileges, and AdminBolt does not support changing an account's primary domain. Upmind receives a provision error for these operations.

Requirements ​

  • PHP 8.1 or newer, with upmind/provision-provider-shared-hosting 5.x or 6.x.
  • AdminBolt 1.8.2 or newer. The provider looks accounts up by username and plans by their exact name, which older panels do not support.
  • An API key and secret, issued under API Keys in the admin panel or under Reseller API Keys in the reseller panel.

Installation ​

The provider is not published on Packagist. Install it from its package:

  1. Download get.adminbolt.com/bolt-upmind.zip and extract it next to your project. The package holds one folder, bolt-upmind. The link always serves the latest release; every release is also kept at https://get.adminbolt.com/downloads/bolt-upmind/v<version>/bolt-upmind-<version>.zip.

  2. Add it as a Composer path repository and require it:

    bash
    composer config repositories.adminbolt path ./bolt-upmind
    composer require adminbolt/provision-provider-adminbolt:^1.0
  3. Register the provider in your provision registry, alongside the shared-hosting category.

Configuration ​

FieldDescription
hostnameThe AdminBolt panel hostname.
portThe panel API port, 8443 by default.
api_keyThe API key: an administrator key, or a reseller key.
api_secretThe API secret.
use_reseller_apiSet it when the key pair belongs to an AdminBolt reseller. Accounts are then created under that reseller.

Use a dedicated key pair per Upmind instance, with the key's IP whitelist turned on. On a panel older than 1.8.2, every API call fails once the whitelist is on, so upgrade the panel before you turn it on.

Warning: According to the provider's documentation, at debug log level Upmind's provision framework logs every HTTP exchange in full, including the API key and secret headers and the password returned when an account is created. Run a production Upmind instance with a log level above debug, and treat debug logs from a test run as credentials.

How it behaves ​

  • Plans - an Upmind package maps to the AdminBolt hosting plan with exactly the same name.
  • Accounts - accounts are identified by username.
  • Termination - terminating an account that no longer exists in AdminBolt succeeds.
  • Single sign-on - the login link can be used once and is valid for 30 minutes. It does not bypass two-factor authentication: when the account has 2FA turned on, the client still enters the second factor.
  • Usage - disk and bandwidth are reported in MB, and mailboxes as a count. An allocation of 0 in the panel means unlimited and is reported as no limit.
  • Rate limits - one provision function makes several API calls, because the account is looked up by username first. A usage sync over many accounts counts against the rate limits accordingly.

For API errors such as 403 IP address not whitelisted or a plan that is reported as not found, see Troubleshooting in the Billing Integration API guide.