The convert_accesshash_to_token Script

Valid for versions 82 through the latest version

Version:

82


Last modified: September 29, 2020

Overview

The /usr/local/cpanel/scripts/convert_accesshash_to_token script converts a WHM user’s access hash to an API token, which you can use this token to authenticate with WHM. You can view access hashes in WHM’s Remote Access Key interface (WHM >> Home >> Clusters >> Remote Access Key).

Important:
  • When you use this script to convert an access hash to an API token, the system does not revoke the access hash.
  • We strongly recommend that you only run this script one time for each user.

For more information about API tokens, read our Manage API Tokens documentation.

Run the script

To use this script, run the following command as the root user:

/usr/local/cpanel/scripts/convert_accesshash_to_token [options] [user]
Note:

In this example, user represents the WHM username for which to convert an access hash to an API token.

  • If you do not specify a username, this option defaults to the root user.
  • You can specify multiple users when you run this script.

Arguments

The /usr/local/cpanel/scripts/convert_accesshash_to_token script accepts the following arguments:

Option Description Example
--verbose Return a complete list of API tokens that the script generated.
Note:
If you do not receive output, the user that you specified does not possess an access hash to convert to an API token.
/usr/local/cpanel/scripts/convert_accesshash_to_token --verbose
--all-resellers Convert all of the system’s reseller’s access hash keys to API tokens.
Note:
If you use this option, do not include the reseller’s username.
/usr/local/cpanel/scripts/convert_accesshash_to_token --all-resellers

Additional Documentation