This article provides a guide for how to generate API key in WHM for resellers.
Guide for Resellers: How to Generate API Key in WHM
API keys are essential tools for automating tasks and integrating third-party applications with your WHM (Web Host Manager) account. This guide walks resellers through the process of creating a new API key in WHM.
Prerequisites
Before creating a new API key, ensure the following:
- You have reseller privileges in WHM. This is included with all reseller hosting accounts.
Step-by-Step Instructions
1. Log In to WHM
- Open your web browser and navigate to your WHM login URL, typically in the format
https://yourdomain.com:2087
. - Enter your WHM username and password, then click Log In.
2. Locate the API Key Management Interface
- Once logged in, use the WHM search bar located in the top-left corner of the dashboard.
- Type API Token or API Key in the search bar.
- Click on the option labeled Manage API Tokens from the results.
3. Create a New API Key
- On the Manage API Tokens page, click the button labeled Generate Token.
4. Enter Token Details
- Provide a meaningful name for the API token. This helps identify the token’s purpose later (e.g., "Billing Automation" or "Backup Script").
- Optionally, set an expiration date if you want the API token to be valid only for a specific period.
5. Set Permissions for the API Key
-
Select the desired privileges or permissions for the API key. You can either:
-
Choose default settings for reseller-level access.
-
Customize permissions based on the specific tasks the API will perform.
⚠️ Important: Only grant the necessary permissions to limit security risks.
6. Save and Generate the Key
- Click Save or Create to generate the API key.
- WHM will display the newly created API key once. Copy and save the API key in a secure location immediately, as you won’t be able to view it again.
7. Test the API Key
- Use the API key with a third-party application or a script to ensure it is working correctly.
- Confirm the key has the intended access by performing a small, safe operation (e.g., listing accounts or checking account information).
8. Manage API Keys
- Return to the Manage API Tokens page to view or manage existing keys.
- You can revoke an API key if it’s no longer needed.
- Ensure no unused or expired keys are lingering to maintain security.
Security Tips for API Keys
- Keep your API key private: Do not share it with unauthorized individuals or applications.
- Use strong permissions: Only assign the minimal privileges necessary.
- Regularly rotate keys: Periodically revoke old keys and create new ones to enhance security.
- Monitor usage: Keep an eye on logs or system activity associated with the API key to detect any unauthorized access.
By following this guide, resellers can efficiently create and manage API keys in WHM, enhancing their ability to integrate and automate tasks securely.