We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • WHM API 1 Functions - nat_checkip
Skip to end of metadata
Go to start of metadata

Description


This function validates a public IP address on a NAT-configured server.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/nat_checkip?api.version=1&ip=192.168.4.10
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/nat_checkip?api.version=1&ip=192.168.4.10
 Command Line
whmapi1 nat_checkip ip=192.168.4.10


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
	"data": {
		"checked_ip": "192.168.4.10"
	},
	"metadata": {
		"version": 1,
		"reason": "OK",
		"result": 1,
		"command": "nat_checkip"
	}
}
 Output (XML)
<result>
    <data>
        <checked_ip>192.168.4.10</checked_ip>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>nat_checkip</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
ipstring

Required

The local IPv4 address.

A valid IPv4 address.
192.168.4.10

Returns

ReturnTypeDescriptionPossible valuesExample
checked_ipstring

The local IPv4 address.

A valid IPv4 address.
192.168.4.10