(WHM >> Home >> Development >> Manage API Tokens)
The Manage API Tokens interface allows you to create, list, update, and revoke API tokens. This interface also allows you to assign Access Control List (ACL) privileges to API tokens.
API tokens allow you to log in to the server without the need for a password. You can use an API token to authenticate with WHM’s remote API. This is useful, for example, to allow a reseller or third-party developer to run API function calls with your account's data.
|
|
The API Tokens table contains the following information:
Column | Description |
---|---|
Name | The API token's name. |
Created | The time that you created the API token, in the MM DD YYYY hh:mm:ss format. |
Actions |
|
To search for an API token, enter a term in the Search text box. The interface automatically filters the API token names as you type.
To refresh the API tokens list, click the gear icon () next to the Actions column heading and click Refresh List.
To create an API token, perform the following steps:
Enter a name for the API token in the Name text box.
An API token name can only contain up to 50 alphanumeric characters, dashes ( |
Under the Privileges heading, deselect the checkbox for each privilege that you do not wish to assign to the token.
For more information about privileges, read our Edit Reseller Nameservers and Privileges documentation.
|
|
Click Generate. The new API token hash and its name will appear.
Make certain that you save your API token in a safe location on your workstation so you can use it with other features. You cannot access the token after you navigate away from the interface or refresh the API Tokens table. |
Click Yes, I saved my token. The new API token and its creation time will appear in the API Tokens list.
To edit an API token, perform the following steps:
Change the API token's name, ACL privileges, or both, and click Save. A success message will appear in the upper-right corner of the interface.
You must assign at least one ACL privilege to the token. |
To revoke an API token, perform the following steps:
If you revoke an API token, any script or account that uses that API token will no longer function. |
To revoke all of your account's API tokens, click the gear icon () and click Revoke All.