WHM (WebHost Manager) MCP server

Showing 10 of 10 tools

• whm_account_bandwidth

  Read-only

  Return bandwidth usage for the cPanel accounts on the server for a given month. If this connection has an account allowlist, only allowed accounts are returned.

• whm_account_summary

  Read-only

  Return the summary for one cPanel account: its owner, package, disk usage, primary domain, suspension state and contact email. Identify the account by username or by one of its domains.

• whm_change_account_package

  Write

  Move a cPanel account onto a different hosting package. The account's disk quota, bandwidth limit, domain limits and feature list are all re-applied from the new package, so moving to a smaller package can put an account immediately over quota.

• whm_change_account_password

  Write

  Destructive

  Set a new password for a cPanel account. This immediately invalidates the password the account holder is currently using -- they are locked out of cPanel, FTP and webmail until they are given the new one, and running this tool again cannot restore the old password because WHM does not store it in a readable form.

• whm_create_account

  Write

  Provision a new cPanel account on the server. This creates a live Unix account, home directory, DNS zone and mail configuration, and consumes a licence slot. Nothing existing is lost, but the account is real and billable the moment this returns.

• whm_domain_user_data

  Read-only

  Map a domain to the cPanel account that owns it, along with that domain's virtual host configuration (document root, server name, IP). This is the way to find out which account a site belongs to.

• whm_list_account_domains

  Read-only

  List every domain on one cPanel account -- primary, addon, parked and subdomains -- with each domain's type and document root. Use this rather than the account summary when addon and parked domains matter, since the summary reports only the primary domain.

• whm_list_accounts

  Read-only

  List the cPanel accounts on the server, optionally filtered by a search. If this connection has an account allowlist, only allowed accounts are returned.

• whm_list_suspended_accounts

  Read-only

  List the suspended cPanel accounts on the server, with the reason and time recorded for each suspension. If this connection has an account allowlist, only allowed accounts are returned.

• whm_modify_account

  Write

  Change settings on an existing cPanel account: its primary domain, contact email, shell, owner, and its resource limits. Only the fields provided are changed. Changing the domain renames the account's primary domain and rewrites its DNS zone; granting a shell gives the account SSH access to the server.

Showing 9 of 9 tools

• whm_add_dns_zone

  Write

  Create a new DNS zone for a domain, seeded from a WHM zone template (A records, MX, and PTR). This creates DNS only -- it does not create a cPanel account or a web vhost.

• whm_add_zone_record

  Write

  Add a DNS record to an existing zone. Supply the payload fields matching the record type: address (A/AAAA), cname (CNAME), exchange and preference (MX), txtdata (TXT), priority/weight/port/target (SRV), or flag/tag/value (CAA). Adding a record renumbers the lines below it, so any line number read before this call is stale afterwards.

• whm_delete_dns_zone

  Write

  Destructive

  Permanently delete a domain's entire DNS zone and every record in it. The domain stops resolving as soon as the change propagates. This does not remove the cPanel account or its files -- the site simply becomes unreachable by name. There is no undo and no backup taken.

• whm_edit_zone_record

  Write

  Replace the DNS record at a given line number. Read the line number from whm_get_dns_zone immediately before calling, and ideally confirm it with whm_get_zone_record first -- line numbers shift whenever any record is added or removed, and this call overwrites whatever currently sits on that line without checking it is the record you meant.

• whm_get_dns_zone

  Read-only

  Return a domain's full DNS zone as parsed records. Each record carries a `Line` value -- that is the line number the edit and remove tools require, and it is only valid until the next change to the zone.

• whm_get_zone_record

  Read-only

  Return the single zone record at a given line number. Use this to confirm a line still holds the record you expect before editing or removing it.

• whm_list_dns_zones

  Read-only

  List every DNS zone the server is authoritative for, across all cPanel accounts.

• whm_remove_zone_record

  Write

  Destructive

  Permanently delete the DNS record at a given line number. Read the line number from whm_get_dns_zone immediately before calling and confirm it with whm_get_zone_record -- line numbers shift whenever any record is added or removed, so a stale number deletes a different record than intended, with no undo. Removing a record can break mail delivery or take a hostname offline.

• whm_reset_dns_zone

  Write

  Destructive

  Discard a zone's customisations and rebuild it from WHM's default template. Valid TXT records are preserved; every other custom record -- added A records, CNAMEs, MX changes, SRV, CAA -- is lost. Intended for repairing a corrupted zone, not for routine edits.

Showing 7 of 7 tools

• whm_autossl_check

  Write

  Queue an AutoSSL run for one cPanel account, issuing or renewing certificates for its domains. This is a real request to a public certificate authority, not a dry run: it performs domain control validation and consumes issuance quota. Certificate authorities rate-limit per registered domain per week, so repeated calls against the same account can exhaust the quota and block legitimate renewals for days. Run it once and read the outcome with whm_autossl_get_user_status rather than polling by re-running it.

• whm_autossl_get_providers

  Read-only

  List the AutoSSL certificate providers available on this server and which one is currently enabled.

• whm_autossl_get_user_status

  Read-only

  Report the AutoSSL domain-control-validation problems for one cPanel account -- the domains AutoSSL could not secure and why. An empty result means AutoSSL found nothing wrong, which is the normal healthy state.

• whm_delete_ssl_certificate

  Write

  Destructive

  Delete a hostname's SSL virtual host, removing its HTTPS configuration. The site stops serving on port 443 immediately -- visitors on https:// get a connection failure, not a redirect to http://. This does not delete the cPanel account or its files.

• whm_get_ssl_info

  Read-only

  Inspect an SSL certificate: its covered domains, CA bundle, expiry, and associated IP. Pass a domain to look up what the server holds for it, or pass certificate text to parse a certificate you already have. Note that cPanel reports the certificate it considers AVAILABLE for the domain, which is not always the one currently serving traffic.

• whm_install_ssl_certificate

  Write

  Destructive

  Install an SSL certificate and private key on a domain, replacing whatever certificate is currently serving it. The previous certificate and key are overwritten and cannot be recovered through the API, and a mismatched certificate and key will break HTTPS on a live site immediately. Always supply the CA bundle unless the certificate is self-signed -- omitting it leaves an incomplete chain that many clients reject. Pass the PEM text exactly as issued; do not URI-encode it.

• whm_list_ssl_certificates

  Read-only

  List installed SSL certificates and the domains they cover. Without a username this returns every certificate on the server; pass a username to scope it to one account. If this connection has an allowed-accounts list, a username is required.

Showing 5 of 5 tools

• whm_create_package

  Write

  Create a new hosting package (plan) on the server. Creating a package does not change any existing account -- it only makes a new set of limits available to assign.

• whm_delete_package

  Write

  Destructive

  Permanently delete a hosting package. The package definition is gone and cannot be recovered without recreating it by hand from its exact settings. Accounts currently assigned to the package are not deleted, but they are left referencing a plan that no longer exists, which breaks package-based reporting and blocks any later attempt to re-apply their plan's limits.

• whm_edit_package

  Write

  Change the settings on an existing hosting package. Only the fields provided are changed. Note that this reaches beyond the package itself: accounts already assigned to it have the new limits applied, so lowering a quota or bandwidth limit here can put live accounts over their limit immediately.

• whm_get_package

  Read-only

  Return the full configuration of one hosting package: its disk quota, bandwidth limit, domain and mailbox limits, feature list, and shell and CGI settings.

• whm_list_packages

  Read-only

  List the hosting packages (plans) available on the server. These are the plan names accepted by whm_create_account and whm_change_account_package.

Showing 5 of 5 tools

• whm_account_counts

  Read-only

  Return a reseller's total accounts, suspended accounts, and account creation limit. Omit the user to report on the account the API token belongs to.

• whm_list_resellers

  Read-only

  List the reseller accounts on the server.

• whm_reseller_stats

  Read-only

  Return a reseller's information, including the accounts they own and their usage.

• whm_setup_reseller

  Write

  Grant a cPanel account reseller privileges. This is a privilege escalation: the account gains the ability to create, suspend and terminate other cPanel accounts, subject to the limits and package permissions set for it afterwards. It does not by itself grant any account quota.

• whm_unsetup_reseller

  Write

  Destructive

  Revoke a cPanel account's reseller privileges. The accounts it owns are not deleted, but the account loses its control over them -- anyone relying on that reseller login to manage their customers' accounts will lose access until the status is granted again.

Showing 5 of 5 tools

• whm_activate_restore_queue

  Write

  Destructive

  Start WHM's restoration queue, carrying out every restoration queued by whm_restore_account_backup. This is the call that actually overwrites live account data with backup contents, and it starts the ENTIRE queue -- including any restorations queued outside ServeMCP -- so read the queue in WHM before running it. Anything created since each backup was taken is lost. This cannot be limited to one account.

• whm_get_backup_config

  Read-only

  Return the server's backup configuration -- whether backups are enabled, the schedule, retention, and the configured destinations.

• whm_list_backup_sets

  Read-only

  List the backup files held on the server's local disk for its accounts.

• whm_list_backup_users

  Read-only

  List the cPanel accounts that have a backup for a given date, on local disk or on an additional backup destination, along with each account's backup status. WHM keys backups by date rather than by account, so a date is required; to find out whether one account is covered, list a date and look for that account.

• whm_restore_account_backup

  Write

  Destructive

  Add a cPanel account to WHM's restoration queue, to be restored from the backup taken on a given date. Restoring overwrites the account's current live data -- files, databases and mail -- with the older contents of that backup, and anything created since the backup was taken is lost. This call only QUEUES the restoration; it does not carry it out and it does not report on one. The queue must be started separately from WHM's Backup Restoration interface, so a successful result here means the account is scheduled, not that its data has been replaced.

Showing 5 of 5 tools

• whm_api_function_list

  Read-only

  Return the alphabetical list of WHM API 1 functions available on this server. Useful for confirming what this cPanel version supports and what the token is privileged to call. This does NOT list installed applications or software packages.

• whm_list_ips

  Read-only

  Return the IP addresses bound to the server.

• whm_server_hostname

  Read-only

  Return the server's hostname.

• whm_server_version

  Read-only

  Return the cPanel & WHM version running on the server.

• whm_system_load_avg

  Read-only

  Return the server's 1, 5, and 15 minute load averages.

Showing 3 of 3 tools

• whm_configure_service

  Write

  Enable or disable a service, and turn WHM's monitoring of it on or off. Disabling a service stops it for every account on the server; turning off monitoring means WHM will no longer restart it automatically when it fails. At least one of enabled or monitored must be supplied.

• whm_restart_service

  Write

  Destructive

  Restart a service on the server. This drops every live connection to that service across every account on the machine -- restarting httpd interrupts in-flight requests to every hosted site, restarting exim interrupts mail delivery for every account, restarting mysql drops every open database connection. The effect is server-wide, not scoped to one account, and it cannot be limited by the connection's allowed-accounts list.

• whm_service_status

  Read-only

  Return the running state of the server's services -- which are up, which are down, and which are monitored.