BuycPanel Blog

BuycPanel Blog

Latest news and updates

What is the “Manage API Tokens” Interface?

Posted by Allura on 16 05 2018.

A brief overview
With the Manage API Tokens, you can create, enumerate and revoke different API tokens that let you get logged in to the server sans requireing any password. An API token may be used to authenticate with the remote API or WHM.

This comes really handy, for instance, in enabling resellers or 3rd party web developers to run any API function calls with your account information. Presently, using API tokens are allowed with the undermentioned features:

 	DNS Clusters
 	WHM API functions
 	Configuration Clusters.

Also you can’t create any API token for the suspended accounts. If you alter the username of your cPanel account in the Modify an Account interface in WHM vide (Home >> Accounts >> Modify an Account), API tokens related to that account will still be functioning. And if you delete your account with cPanel, the system revokes the API token associated with that account, automatically.

API Tokens Table
The table…

A brief overview

With the Manage API Tokens, you can create, enumerate and revoke different API tokens that let you get logged in to the server sans requireing any password. An API token may be used to authenticate with the remote API or WHM.

This comes really handy, for instance, in enabling resellers or 3rd party web developers to run any API function calls with your account information. Presently, using API tokens are allowed with the undermentioned features:

  • DNS Clusters
  • WHM API functions
  • Configuration Clusters.

Also you can’t create any API token for the suspended accounts. If you alter the username of your cPanel account in the Modify an Account interface in WHM vide (Home >> Accounts >> Modify an Account), API tokens related to that account will still be functioning. And if you delete your account with cPanel, the system revokes the API token associated with that account, automatically.

API Tokens Table

The table namely API Tokens features following data.

  • Name – Describes the name of API Token.
  • Created – Describes the time when you created your API token in a MM DD YYYY hh:mm:ss format.
  • Actions – Describes if the API token is to be revoked.

While looking for an API token, you need to insert the term in Search box. The interface will automatically filter the token names while you type. To refresh the token list, choose the gear icon next to Actions column followed by clicking Refresh List.

Creating API tokens

While creating an API token, follow the below-mentioned steps:

  • Click the Generate Token to let the form appear.
  • Insert a name for the token in the Name

Please note that the maximum length of the token name is 50 characters containing only alphanumeric characters as well as underscores and dashes.

  • Click Generate New API token along with its name and creation time will be appeared in API Tokens menu.

Make sure you save the token in a safe location on the workstation. You can’t access your token after navigating away from that interface or refreshing the table namely API Tokens.

Revoking API Tokens

While revoking a token, follow the undermentioned steps.

  • Locate the token that you need to revoke in API Tokens
  • Click Revoke option under Actions column to get the confirmation message.
  • Click Continue option to get the token revoked. A message prompting your success will appear.