Tip: Start typing in the input box for immediate search results.

< Back
Print

Create API token – cPanel

Learn how to create an API token in cPanel. The cPanel APIs (Application Programming Interfaces) allow users to access the software’s built-in functionality without going through the web interface. To use the APIs, you send a command, and cPanel responds by carrying out an action, which could be to change a setting, perform a server administration task, or tell you some information.
The need for an API token is that a user will be able to log in into the server without the need for a password.
APIs help users and developers leverage cPanel’s server and hosting administration technologies to solve problems, save time, and build flexible tools for their users.


Video tutorial – Create API token – cPanel


Step-by-step tutorial – Create API token – cPanel

  1. cPanel

    Login to cPanel.
    Tutorial: login from the Client Area or the direct link.

    Find the Security section and click the Manage API Tokens link.

    Extilum cPanel - Revoke API token

  2. Manage API Tokens

    On the Manage API Tokens page, click the +Create button.

    Extilum cPanel - Create API token

  3. Create API Token

    The Create API Token interface will appear.
    Enter a unique name in the API Token Name text box.

    An API token name can only contain up to 50 characters.
    You can only enter letters (az and AZ), numbers (09), dashes ( - ), and underscores ( _ ).


    Select one of the following options from the Should the API Token Expire? section:

    The API Token will not expire.
    — This will create a token that does not have an expiration date.
    By default, tokens expire one year from the current date.

    Specify an expiration date.
    — This allows you to create a token that expires on a specific date.
    When you select this option, the interface displays the API Token Expiration Date section.
    Use the calendar icon (Calendar) to open a calendar to select a desired expiration date.
    You can also enter a custom date in the calendar text box, in YYYY-MM-DD format.
    The token will expire on the date you select at 23:59:59, server time.

    Important:
    You cannot edit an API token expiration date after creation.
    When an API token expires, the system will not remove it. You must manually delete an API token.


    Extilum cPanel - Create API token

  4. Click Create.


    Extilum cPanel - Create API token

  5. Wait for the success message.


    Extilum cPanel - Create API token

  6. Token created successfully page

    To copy the API token, click the Copy link. Think of this token like a password. You must enter this token each time that you use it.

    You cannot access the token after you navigate away from the interface.
    If you forget or misplace this token, you must revoke the token and then create a new one.


    Extilum cPanel - Create API token

  7. Wait for the success message


    Extilum cPanel - Create API token

  8. Token created successfully page

    — To create a new token, select the Create another token after I click Yes, I saved my token checkbox.
    — To return to the List API Tokens interface, deselect the Create another token after I click Yes, I saved my token checkbox.

    Click Yes, I Saved My Token.

    Extilum cPanel - Create API token

  9. Check the newly created token in the Token Table.


    Extilum cPanel - Create API token

Was this article helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Next Manage API token – cPanel