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

 

Description

This function changes a site's or account's IP address.

Examples 


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


Notes:

  • 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": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "setsiteip"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>setsiteip</command>
    </metadata>
</result>


Note:

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

   

Parameters

Note:

You must use either the user or domain parameters.


ParameterTypeDescriptionPossible valuesExample
ipstring

Required

The site's or user's IPv4 address.

A valid IPv4 address.
192.168.4.10
userstringThe user's username.A valid username.username
domainstringThe domain's name.A valid domain name.example.com

Returns

This function only returns metadata.