Child pages
  • Guide to API Authentication - API Tokens in WHM

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

Excerpt

API tokens allow you to call WHM API 1 functions outside of a WHM session.

 You can use API tokens instead of a password or access hash key to call WHM API 1 functions over HTTPS. This is useful, for example, to allow a reseller user or third-party developer to run API function calls with your account's data.

Warning
titleImportant:
  • We introduced this functionality in cPanel & WHM version 64.
  • API calls using a method that includes a URL must use one the following ports:
    • 2087 — Secure calls to WHM's APIs, or to cPanel's APIs via the WHM API.
    • 443 — Secure calls to WHM's APIs, or to cPanel's APIs via the WHM API through a service subdomain.

Creating an API token

To create an API token, use WHM's Manage API Tokens interface (WHM >> Home >> Security Center >> Manage API Tokens). You can also use the WHM API 1 api_token_create function.

Note
titleNote:
  • In cPanel & WHM version 82, when an API token expires, the system does will not remove it. You must manually delete an API token.
  • You can remove an API token with WHM's Manage API Tokens interface (WHM >> Home >> Security Center >> Manage API Tokens) or the WHM API 1 api_token_revoke function.


Warning
titleWarning:

Make certain that you save your API token in a secure location on your workstation. You cannot access the token after navigating away from the interface or refreshing the API Tokens table.

Using an API token

To call a WHM API 1 function with an API token, call it via HTTPS and include the following HTTP header in your request: 

Code Block
languagebash
Authorization: whm username:token


Note
titleNote:

In this example, username represents the root user or a reseller user and token represents the API token.

Example scripts

Use the following examples to create a script that includes the API token in your custom code:

Localtab Group


Localtab
idAPITokenWHMPerlscript
titlePerl


Note
titleNote:
  • Specify either the root user or a reseller user in line 9.

  • Replace MYAPITOKEN in line 10 with your valid API token.
  • Replace 127.0.0.1 in line 18 with your server's IP address.


Code Block
languageperl
linenumberstrue
#!/usr/bin/perl
use strict;
use warnings;

use JSON       ();
use HTTP::Tiny ();


my $user  = 'root';
my $token = 'MYAPITOKEN';
my $ua = HTTP::Tiny->new(
    'verify_SSL'      => 0,
    'default_headers' => {
        'Authorization' => "whm $user:$token", 
    },
);

my $response = $ua->get("https://127.0.0.1:2087/json-api/listaccts?api.version=1");
if ( $response->{'success'} ) {
    my $json = JSON::decode_json( $response->{'content'} );
    print "[+] Current cPanel users on the system:\n";
    print "\t$_\n" for map { $_->{'user'} } @{ $json->{'data'}->{'acct'} };
}
else {
    print "[!] Error: $response->{'status'} $response->{'reason'} returned\n";
}
  • In line 10, the script declares the $token variable and assigns the API token hash to it as a value.
  • In line 11, the script creates an HTTP::Tiny user agent. It also configures it to send the token authorization headers with every request.
  • Line 18 invokes the WHM API 1 listaccts function via the HTTP::Tiny user agent and saves the response in the $response variable.
  • The script prints the following output:
    • If the listacct function succeeds, it parses the JSON data and returns the account's usernames.
    • If the listacct function fails, it returns an error message.


Localtab
idAPITokenWHMPHPscript
titlePHP


Note
titleNotes:
  • Specify either the root user or a reseller user in line 2.

  • Replace MYAPITOKEN in line 3 with your valid API token.
  • Replace 127.0.0.1 in line 5 with your server's IP address.


Code Block
languagephp
linenumberstrue
<?
    $user = "root";
    $token = "MYAPITOKEN";

    $query = "https://127.0.0.1:2087/json-api/listaccts?api.version=1";

    $curl = curl_init();
    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST,0);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER,0);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER,1);

    $header[0] = "Authorization: whm $user:$token";
    curl_setopt($curl,CURLOPT_HTTPHEADER,$header);
    curl_setopt($curl, CURLOPT_URL, $query);

    $result = curl_exec($curl);

    $http_status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
    if ($http_status != 200) {
        echo "[!] Error: " . $http_status . " returned\n";
    } else {
        $json = json_decode($result);
        echo "[+] Current cPanel users on the system:\n";
        foreach ($json->{'data'}->{'acct'} as $userdetails) {
            echo "\t" . $userdetails->{'user'} . "\n";
        }
    }

    curl_close($curl);
?>
  • Line 2 sets the $user value as the root user.
  • Line 3 sets the $token value as the contents of the appropriate API token.
  • Line 5 initializes the WHM API 1 listaccts function via a curl call. It then configures the call to send the Authorization: token $user:$token headers with every request.

  • Line 16 performs the WHM API 1 listaccts function via a curl call and saves the response in the $response variable.
  • The script prints the following output:
    • If the listacct function succeeds, it parses the JSON data and returns the account's usernames.
    • If the listacct function fails, it returns an error message.


Localtab
activetrue
idAPITokenWHMcurl
titlecurl


Localtab
activetrue
idAPITokenWHMcurl
titlecurl


Note
titleNote:
  • Specify either the root user or a reseller user for the username entry.

  • Replace MYAPITOKEN with your valid API token.
  • Replace 127.0.0.1 with your server's IP address.


Code Block
languagetext
curl -H'Authorization: whm username:MYAPITOKEN' 'https://127.0.0.1:2087/json-api/applist?api.version=1'