Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - nat_set_public_ip - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - nat_set_public_ip
Skip to end of metadata
Go to start of metadata

 

Description

This function pairs a local IP address with a public IP address on NAT-configured servers.

Examples 


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


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)
{
  "metadata":{
    "reason":"OK",
    "result":1,
    "version":1,
    "command":"nat_set_public_ip"
     }
}

 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <result>1</result>
        <reason>OK</reason>
        <command>nat_set_public_ip</command>
    </metadata>
</result>


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
local_ipstring

Required

The local IPv4 address.

A valid IPv4 address.
192.168.4.10
public_ipstring

Required

The public IPv4 address.

A valid IPv4 address.
10.5.3.333

Returns

This function only returns metadata.