Validate public IP address for NAT

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

SecurityBasicAuth
Request
query Parameters
ip
required
string <ipv4>

The local IPv4 address.

Example: ip=192.168.4.10
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/nat_checkip
Request samples
whmapi1 --output=jsonpretty \
  nat_checkip \
  ip='192.168.4.10'
Response samples
application/json
{
  • "data": {
    • "checked_ip": "192.168.4.10"
    },
  • "metadata": {
    • "command": "nat_checkip",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}