# KeyHelp

https://docs.wisecp.com/en/keyhelp

Connect KeyHelp to WISECP to manage hosting clients, domains and account resources from service records.

## Accessing the Screen

Open **Products → Servers → Add New Server**. Select **KeyHelp** under **Server Automation Module**. Edit existing records from the server list.

## Before You Start

Prepare a KeyHelp server with the supported v2 API and create its API token in Panel → Settings → API. Permit the client, hosting-plan, domain, statistics, login and hosting-tool endpoints you will use. WISECP needs PHP cURL and network access to the panel.

Sales require an active server, an available module license and a hosting product priced in your chosen currency. Saved servers have **Preferences**, **Linked Services** and **Import** sections.

## Connection and Product Settings

- **Address / Hostname**: Both required. Hostname must be the real panel hostname, not a descriptive label; Address can be its IP. Defaults: SSL 443, non-SSL 80. The API path is added automatically.
- **Username / API Key**: The form requires Username, although the API uses the token only. Enter the token in API Key. A separate password is unnecessary when the key is present.
- **Verify SSL Certificate**: Enabled for new servers. Keep SSL and certificate verification enabled. Use Custom Port selects a different port.
- **Identity and Capacity**: Monthly Cost starts at zero; choose its currency. Maximum Accounts defaults to 200 when blank. The occupancy alert follows this limit. Nameservers accepts four lines.
- **Hosting Plan**: Required for creation. Select a plan by name under Automation → Module Configuration. Selection fills product resource limits. Keep the same plan names across a server group.

## Tasks

### Connecting the Server

1. Complete **Connection Details** and click **Test Connection** in the server summary.
2. The test checks authenticated ping. On the server form it may also fill Hostname and Address from panel information. Verify those values before saving; ping does not prove write permissions.
3. Complete **Identity and Capacity**, then click **Add New Server**; verify the list entry. When editing, use **Save Changes**.

### Mapping a Product

1. Select **KeyHelp** in the hosting product’s **Automation → Module Assignment** section.
2. Under **Server Configuration**, choose **Single Server** or **Server Group**. Set **Module Configuration → Hosting Plan**.
3. Check **Resource Limits** and prices. Keep the initial product hidden and **Automatic Setup** disabled.
4. Click **Save Changes**; verify the product’s server and plan mapping.

KeyHelp disk and traffic bytes convert to MB in WISECP. Mailbox, database, domain, subdomain and FTP counts follow the plan; -1 means unlimited. Parked-domain and hourly-email limits have no plan counterpart. The panel plan controls resources; changing displayed WISECP limits alone does not alter the plan.

Creation opens a client with the chosen plan and attempts to attach the service domain. Domain errors do not prevent a successful account result; verify the domain separately. A pre-existing username skips both creation steps. No saleable addon or order requirement is created automatically.

### Linking Existing Accounts

The list matches clients to their first non-system, top-level domain. A missing match can show the username instead; check it before import. The list does not retrieve passwords or the selected hosting plan.

On the saved server, click **Import → List Results**. Select accounts and map their client, product, cycle and dates. Click **Import** below the list; verify the existing account appears in **Linked Services** without being recreated.

### Managing the Service

Account creation, suspension, reactivation, termination and password changes are supported. In **Management → Settings → Change Package**, select another plan and click **Save Changes**; it changes the existing client’s plan. Product upgrades also switch the plan without recreating the account.

Administrators and customers open permitted hosting tools from the service’s **Management** tab. Tools disabled in server **Preferences** are hidden. See [Service Management](https://docs.wisecp.com/en/service-management) for action dialogs.

FTP accounts can be created, edited and deleted; custom directories and individual quotas are unavailable. Databases have one associated user and no separate user-management tools. Mailboxes, addon domains, subdomains, DNS records and cron jobs can be managed. Domain document roots can be changed. SSL supports Let’s Encrypt and custom certificates, without a reinstall action. Global cron notification email is unavailable.

Customer panel access requests a generated login URL. Root access opens the normal panel login page; it does not create an administrator login token.

Disk and traffic gauges and resource counts use account statistics. This module has no automatic metric-collection method, so these gauges do not enable usage billing. File manager, PHP version, email-forwarder and webmail tools are not offered here.

Before enabling automatic setup, compare **Management → Overview** with the panel on an existing test service. Plan selection does not periodically synchronize a product catalog or provider prices.

## Important Notes

> **Account Changes**
> 
> Suspension affects the whole KeyHelp client. Termination deletes the client and its resources; back up first. Check domain creation and new plan limits before delivering the account.

## Required Permissions

Server settings require **MODULES_SERVERS_SETTINGS**; product editing requires **PRODUCTS_OPERATION**. Service actions require their corresponding service permissions.

## Related Articles

- [Adding a Server](https://docs.wisecp.com/en/adding-a-server)
- [Product Automation](https://docs.wisecp.com/en/product-automation)
- [Server Groups](https://docs.wisecp.com/en/managing-server-groups)
