Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function assigns a main IP address to a reseller's account.

Note
titleNote:

 To assign additional IP addresses to a reseller's account, call the WHM API 1 setresellerips function.

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/setresellermainip?api.version=1&user=username&ip=192.168.0.20
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/setresellermainip?api.version=1&user=username&ip=192.168.0.20
Expand
titleCommand Line
Code Block
languagebash
whmapi1 setresellermainip user=username ip=192.168.0.20

Include Page
_WHMAPI1CLINote
_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "setresellermainip"
  }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>setresellermainip</command>
    </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The reseller's username.

A valid reseller username on the server.username
ipstring

Required

The IP address to assign to the reseller's account as the main shared IP address.

A valid IP address.192.168.0.20

Returns

This function only returns metadata.