{"id":362,"date":"2021-07-23T12:28:30","date_gmt":"2021-07-23T12:28:30","guid":{"rendered":"https:\/\/ssdsunucum.com\/blog\/how-to-use-cpanel-api-tokens\/"},"modified":"2021-07-23T12:28:30","modified_gmt":"2021-07-23T12:28:30","slug":"how-to-use-cpanel-api-tokens","status":"publish","type":"post","link":"https:\/\/ssdsunucum.com\/blog\/how-to-use-cpanel-api-tokens\/","title":{"rendered":"How to Use cPanel API Tokens"},"content":{"rendered":"<\/p>\n
\n
<\/div>\n
\n

Overview<\/h2>\n

In cPanel & WHM version 80, we introduced cPanel application programming interface (API) tokens. cPanel users can issue these API tokens. The server recognizes API tokens and allows other users to run API functions with the account\u2019s data. API functions allow you to view and change account data without the need to log in to the cPanel interface. For example, you could issue an API token to a third-party developer. That third-party developer could use that token to check disk usage.<\/p>\n

\n
Note:<\/div>\n
\n
    \n
  • API tokens run UAPI functions and cPanel API 2 functions, not<\/strong> cPanel API 1 functions. For more information, read our Quickstart Development Guide documentation.<\/li>\n
  • If you do not<\/strong> see this feature, your system administrator has disabled it. Contact them and ask them to enable this feature in WHM\u2019s Feature Manager<\/em> interface (WHM >> Home >> Package >> Feature Manager<\/em>).<\/li>\n<\/ul><\/div>\n<\/div>\n

    How to use a cPanel API token<\/h2>\n

    To use a cPanel API token, first, create a cPanel API token in cPanel\u2019s Manage API Tokens<\/em> interface (cPanel<\/em> >> Home<\/em> >> Security<\/em> >> Manage API Tokens<\/em>). Then, use the token to run API functions on the server.<\/p>\n

    Create an API token<\/h3>\n

    You can use one of the following methods to create an API token:<\/p>\n

      \n
    • \n

      Use cPanel\u2019s Manage API Tokens<\/em> interface (cPanel<\/em> >> Home<\/em> >> Security<\/em> >> Manage API Tokens<\/em>).<\/p>\n<\/li>\n

    • \n

      Use the UAPI Tokens::create_full_access<\/code> function.<\/p>\n<\/li>\n<\/ul>\n

      \n
      Note:<\/div>\n
      \n
        \n
      • In cPanel & WHM version 82, when an API token expires, the system does not<\/strong> remove it. You must<\/strong> manually delete an API token.<\/li>\n
      • You can remove an API token with cPanel\u2019s Manage API Tokens<\/em> interface (cPanel >> Home >> Security >> Manage API Tokens<\/em>) or the UAPI Tokens::revoke<\/code> function.<\/li>\n<\/ul><\/div>\n<\/div>\n

        Run API functions with the token<\/h3>\n
        \n
        Remember:<\/div>\n
        \n

        You must<\/strong> use the API token that you created in cPanel.<\/p>\n<\/p><\/div>\n<\/div>\n

        To call a UAPI<\/code> or cPanel API 2<\/code> function with an API token, run the following command from the command line:<\/p>\n

        \n
        curl<\/span> -<\/span>H<\/span>'<\/span>Authorization<\/span>: cpanel<\/span> username<\/span>:APITOKEN<\/span>' '<\/span>https<\/span>:\/\/<\/span>example<\/span>.com<\/span>:2083<\/span>\/<\/span>execute<\/span>\/<\/span>Module<\/span>\/<\/span>function<\/span>?<\/span>parameter<\/span>=value<\/span>'<\/span><\/code><\/pre>\n<\/div>\n
        This example uses the following format:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
        Item<\/th>\nDescription<\/th>\nExample<\/th>\n<\/tr>\n<\/thead>\n
        username<\/code><\/td>\nThe cPanel account\u2019s username.<\/td>\nusername<\/code><\/td>\n<\/tr>\n
        APITOKEN<\/code><\/td>\nThe API token.<\/td>\nU7HMR63FGY292DQZ4H5BFH16JLYMO01M<\/code><\/td>\n<\/tr>\n
        example.com<\/code><\/td>\nYour cPanel server\u2019s domain.<\/td>\nexample.com<\/code> <\/p>\n
        \n
        Note:<\/div>\n
        \n        Alternatively, you can enter your server\u2019s IP address.\n    <\/div>\n<\/div>\n<\/td>\n<\/tr>\n
        Module<\/code><\/td>\nThe API module name.<\/td>\nEmail<\/code><\/td>\n<\/tr>\n
        function<\/code><\/td>\nThe API function\u2019s name.<\/td>\nadd_pop<\/code><\/td>\n<\/tr>\n
        parameter<\/code><\/td>\nThe function\u2019s input parameters.<\/td>\nemail<\/code><\/td>\n<\/tr>\n
        value<\/code><\/td>\nThe value to assign to the input parameter.<\/td>\n12345luggage<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
        For example, your command may resemble the following example:<\/p>\n
        \n
        curl<\/span> -<\/span>H<\/span>'<\/span>Authorization<\/span>: cpanel<\/span> username<\/span>:U7HMR63FHY282DQZ4H5BIH16JLYSO01M<\/span>' '<\/span>https<\/span>:\/\/<\/span>example<\/span>.com<\/span>:2083<\/span>\/<\/span>execute<\/span>\/<\/span>Email<\/span>\/<\/span>add_pop<\/span>?<\/span>email<\/span>=newuser<\/span>&<\/span>password<\/span>=12345<\/span>luggage<\/span>'<\/span><\/code><\/pre>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
        Overview In cPanel & WHM version 80, we introduced cPanel application programming interface (API) tokens. cPanel users can issue these API tokens. The server recognizes API tokens and allows other users to run API functions with the account\u2019s data. API functions allow you to view and change account data without the need to log in …<\/p>\n","protected":false},"author":1,"featured_media":363,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/362"}],"collection":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/comments?post=362"}],"version-history":[{"count":0,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/362\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media\/363"}],"wp:attachment":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media?parent=362"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/categories?post=362"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/tags?post=362"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}