Knowledge Base

How Can We Help?

How to manage API Tokens in cPanel

You are here:

Nowadays, we have the privilege to utilize API for programmatically utilizing any system that offers API access. The good news is, cPanel now also provides us with API! It means that a reseller or innovator can use the API to create a system based on cPanel that can automate many tasks. Let’s explore how we can effectively manage API tokens in cPanel.

Managing API Tokens in cPanel

cPanel is one of the well-known and widely used web hosting control panels in Linux-based servers. From cPanel version 80 onwards, a new feature has been introduced known as Manage API Token. This interface is utilized to generate and revoke sets of API tokens. The purpose of an API token is that a user can authenticate into the server without the need for a password. An API token can be utilized for authentication with the WHM remote API. This feature allows cPanel users to issue API tokens for Resellers and third-party developers to run API functions.

In this tutorial, we will discuss how to create and revoke an API token in cPanel. Please note, this feature is only available from cPanel version 80 onwards.

1) Access the cPanel server and log in.

2) Proceed to Security >> Manage API Tokens.

Api Tokens

3) You can enter the API Token name, then click on “Create”. I have used “test” as the token name but you can name it whatever you prefer, it is solely for identification purposes.

Api Tokens

4) Now, an unrestricted API token has been created. The subsequent page will display the API token, and you can copy it. Copy the API token by clicking on “COPY” as shown in the image below and then click on “YES, I SAVED MY TOKEN”.

Api Tokens

5) Congratulations! You have successfully created the API token. If you wish to revoke or rename an API token, click on the “MANAGE” button corresponding to the API token.

Api Tokens

6) In the following interface, you can rename the API token and then click on the “UPDATE” button to modify the token.

Manage Api Token

 

7) If you want to revoke the API token, click on “YES REVOKE THE TOKEN”. You have successfully invalidated the API token. Revoking a token renders it useless. It means that if you are using that token in any of your applications, it will no longer function.

Manage Api Tokens

If you require further assistance with managing API tokens in cPanel, please reach out to our support department. You can also leave your queries in the comment section and we will respond as soon as possible.

Leave a Comment