Page tree
Skip to end of metadata
Go to start of metadata

For cPanel & WHM version 60

(Home >> Development >> API Shell)

Overview

This feature allows you to call WHM API functions interactively within the interface.

To enable this feature, you must enable the cPanel & WHM API Shell (for developers) setting in WHM's Tweak Settings interface (Home >> Server Configuration >> Tweak Settings).

Note:

 Only the root user and root-enabled resellers may use this feature.

Warning:

This feature uses live data from your server. API function calls may change or delete data on your server, which can cause your server to fail. Read each function's documentation thoroughly before you use it in the API Shell interface, a script, or through any other method.

For an example of a function's output that uses test data, read the Example section for that function call in our Guide to WHM API 1 documentation.

Call a WHM API function

To call a WHM API function, perform the following steps:

  1. Select a version of the WHM API.

    Notes:

    • To learn more about each function, click WHM API v1 Documentation.
    • Only WHM API version 1 is available through this interface.
  2. From the v1 menu, select the function that you wish to test.

  3. Enter the input parameters that you wish to test, and their values.
    • To enter more parameters and values, click Add.
  4. To filter, sort, or paginate the results, click Show Sort/Filter/Paginate Options.
    1. To select the first record to show from the results, select the number from the Index (0-based) of first result to show menu.
    2. To limit the number of results that the interface displays, specify the maximum number of results that you wish to display in the Maximum # of results to show menu.
    3. To filter the results, click Add in the Filters section of the interface.
      • Enter the appropriate information in the Field text box, condition menu, and Term text box.
      • To enter more filters, click Add.
    4. To sort the results, click Add in the Sorts section of the interface.
      • Enter the appropriate information in the Field text box and condition menu, and select whether you wish to Reverse the sort order.
      • To enter more sort methods, click Add.
    5. To limit the columns to display, click Add in the Columns section of the interface.
      • Enter the appropriate information in the Column text box.
      • To enter more columns to display, click Add.
  5. Click Submit.

API call results

The system displays the results in the API call response section of the interface.

You can view the results under the TableTree, or Raw response tabs.

Note

 The Raw response separates the function call's response from the HTTP headers.

Additional documentation

There is no content with the specified labels