CPcpanel
IP Addresses
Network Address Translation

Validate public IP address for NAT

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

get/nat_checkip

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

ipstring ipv4 required
Example:192.168.4.10

The local IPv4 address.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "checked_ip": "192.168.4.10"
  },
  "metadata": {
    "command": "nat_checkip",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.