BuycPanel Blog

BuycPanel Blog

Latest news and updates

Key Steps to Create, Edit and Remove Manage API Token

Posted by Allura on 31 05 2019.

Introduction
One is able to create, list and remove API token with the help of the Manage API Tokens interface. These API tokens help one to log in to the server where one necessarily do not need a password. One can make a use of an API token to substantiate with WHM’s remote API.It is useful in the sense that it permits a reseller or third-party developer to run the API function calls with one’s account’s data.The API Tokens
The API tokens has the following instructions:Name: The API token’s name
Created: The time when one created the API token, in the format MM:DD:YYYY hh:mm:ss.
Actions: Edit or revoke the API token.One needs to enter a term in the Search text box in order to search for an API token. The interface will then accordingly filter the API token name as and when one will type.In order to refresh the API…

Introduction

One is able to create, list and remove API token with the help of the Manage API Tokens interface. These API tokens help one to log in to the server where one necessarily do not need a password. One can make a use of an API token to substantiate with WHM’s remote API.

It is useful in the sense that it permits a reseller or third-party developer to run the API function calls with one’s account’s data.

The API Tokens

The API tokens has the following instructions:

  • Name: The API token’s name
  • Created: The time when one created the API token, in the format MM:DD:YYYY hh:mm:ss.
  • Actions: Edit or revoke the API token.

One needs to enter a term in the Search text box in order to search for an API token. The interface will then accordingly filter the API token name as and when one will type.

In order to refresh the API tokens list, one needs to select the gear icon next to the Actions column heading and click on Refresh list.

Create an API Token

Steps:

1- One needs to click on Generate Token option. The generate token form will appear thereafter.

2- Then one needs to enter a name for the API token in the Name text box.

It is to note that an API token name’s length can be upto 50 characters maximum and can only contain alphanumeric characters, dashes (-), and underscores (_).

3-One has to deselect the checkbox under the Privileges heading, for each privilege that you do not  wish to assign to the token.

One can read our Edit Reseller Nameservers and Privileges  documentation to get more idea about privileges.

4- Then, click on Generate. The all new API token, its name, its creation time will appear in the API Tokens menu.

5- Lastly, click on Yes, I saved my token thereby displaying the new API token and its creation time in the API Tokens list.

Edit an API Token

Steps:

  • Firstly, locate the API token that is to be edited in the API Tokens list.
  • Then, click on Edit, under the Actions column.
  • To complete the process, either change the API token’s name, ACL privileges, or both of them, and Save the changes. In the upper-right corner of the interface, a succession message will appear. Also, remember to assign at least one ACL privilege to the token.

Revoke an API Token

Steps:

  • One needs to locate the API token one wish to revoke in the API Tokens
  • Secondly, one needs to click on Revoke under the Actions A message of confirmation will appear thereafter.
  • To revoke the token, finally click on Continue. In the upper-right corner of the interface, a message of success will appear confirming the revoke of the token.

In order to revoke all the API tokens, one can click on the gear icon available and click on Revoke All. Your work will be done.

Conclusion

All information about manage API token is outlined in this review.