An API is a unique identifier or authentication that allows an application to access a service. Starting from version 80 in cPanel, it is possible to create and manage API Tokens. The main function of the API token is to give the user password-free access to the server.
Thus, by issuing API tokens, vendors or third-party developers can be allowed to ship API2 and UAPI functionality.
1. Log in to your cPanel account.
2. Scroll to the SECURITY section and click Manage API Tokens.
The Manage API Tokens screen appears.
First, you will need to create a new API token.
To create API tokens
-
Enter the name of the API token in the API Token Name field.
-
Select the Specify an expiration date option.
-
In API Token Expiration Date , select the date from the calendar. Until then, the token will be useful.
-
Click on Create.
Note: While you can select The API Token will not expire option, we strongly recommend that it does not.
A success message will be displayed when cPanel creates a new token.
5. Copy the API token to a discreet location and share it with your user later.
6. Click Yes, I Keep My Token.
The API token you created now appears in the list of active API tokens.
To manage API tokens
1. Click the Manage button for the API token you want to manage.
There will be two sessions:
-
MANAGE API TOKEN: Here, you can change the name of the API Token.
-
REVOKE API TOKEN: Allows you to discard an API token. The MANAGE API token
MANAGE API TOKEN
-
Enter the new name for the API token in the New API Token Name field.
-
Click the Update button.
The name of the API token will get modified to the new one you just updated and chnaged.
REVOKE API TOKEN
1. Click on Revoke The Token.
A message will flash asking for your confirmation.
2. Click on the Yes, Revoke The Token button.
The system will convert the API Token invalid and discard it from the list of tokens that are active.
All these steps are to know about configuring API tokens in cPanel.