# cPanel API 2 Functions - Net::traceroute

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function uses `traceroute` to retrieve the local IP address.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Net&cpanel_jsonapi_func=traceroute
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Retrieve IP address traceroute.
$get_IP_traceroute = $cpanel->api2(
    'Net', 'traceroute'
 );
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Retrieve IP address traceroute.
my $get_IP_traceroute = $cpliveapi->api2(
    'Net', 'traceroute',

 );
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Net traceroute
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** include the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the
`cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
                                {
   "cpanelresult" : {
      "apiversion" : 2,
      "data" : [
         {
            "line" : "traceroute to 127.0.0.1 (127.0.0.1), 30 hops max, 60 byte packets"
         },
         {
            "line" : " 1  localhost (127.0.0.1)  0.048 ms  0.013 ms  0.029 ms"
         }
      ],
      "event" : {
         "result" : 1
      },
      "func" : "traceroute",
      "module" : "Net"
   }
}
```

Note:
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
br
td
em
array of hashes
td
An array of hashes that contain information about the traceroute results.
td
This array of hashes includes the 
code
line
 return.
td
br
tr
td
p
code
line
td
em
string
td
p
The result of the traceroute process.
p
The function returns this value in the unnamed hash.
td
The 
code
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.
td
code
traceroute to 10.1.14.78 (10.1.14.78), 30 hops max, 60 byte packets
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
Note: This function only returns a 
code
reason
 value if there was an error. 
td
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
p
br
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1