cPanel API 2 Functions - Net::traceroute


This function uses traceroute to retrieve the local IP address.


We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.




 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
// Retrieve IP address traceroute.
$get_IP_traceroute $cpanel->api2(

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
# Retrieve IP address traceroute.
my $get_IP_traceroute $cpliveapi->api2(

 cPanel Tag System (deprecated)


In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.


 Command Line

cpapi2 --user=username Net traceroute



  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

   "cpanelresult" : {
      "apiversion" : 2,
      "data" : [
            "line" : "traceroute to (, 30 hops max, 60 byte packets"
            "line" : " 1  localhost (  0.048 ms  0.013 ms  0.029 ms"
      "event" : {
         "result" : 1
      "func" : "traceroute",
      "module" : "Net"



Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.



This function does not accept parameters.






Possible values



array of hashes

An array of hashes that contain information about the traceroute results

This array of hashes includes the line return.




The result of the traceroute process.

The function returns this value in the unnamed hash.

The traceroute to string, the host, the IP address in parenthesis, the maximum amount of time the packet requires to travel to the destination, and the packet size , in bytes.

traceroute to (, 30 hops max,  60 byte packets



A reason for failure.



 This function only returns areason value if there was an  error. 



A string that describes the error.

This is an error message.



Whether the function succeeded.


  • 1 — The function succeeded.
  • 0 — The function failed.



  • 13 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....