Chapter 20: Controller: /nodeworx/ip Up Part II: NodeWorx API Spec Chapter 22: Controller: /nodeworx/ipv6 

21 Controller: /nodeworx/ip/sites

Required Permissions "IPS"
Action: defaultSitesStatus
Added in version 4.8.0-393
Description Change the status of the Default Sites feature.
Input Parameters
Name Type Notes Required?
status integer Example Values
1, 0
Example Default Value
1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: disableDefaultSites
Added in version 4.8.0-393
Description Disables default sites feature.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: enableDefaultSites
Added in version 4.8.0-393
Description Enables default sites feature.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: listIpDefaultSites
Added in version 4.8.0-393
Description List the sites IPs redirect to when requested like http://ip.ad.dr.es/.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’ip’ => ’10.1.15.100’,
’location’ => ’/var/www/html’,
’domains’ => ’example.com, secondary.com’,
),
1 =>
array (
’ip’ => ’10.1.15.101’,
’location’ => ’/var/www/html’,
’domains’ => ’’,
),
2 =>
array (
’ip’ => ’10.1.15.102’,
’location’ => ’/var/www/html’,
’domains’ => ’’,
),
),
)
Action: queryDefaultSitesStatus
Added in version 5.1.0-838
Description Displays the information available to the action "defaultSitesStatus".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’status’ => ’1’,
),
)
Action: updateIpDefaultSites
Added in version 4.8.0-393
Description Change the locations IPs redirect to when requested like http://ip.ad.dr.es/.
Input Parameters
Name Type Notes Required?
ip struct (string) Help Entry
####
Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
site string Description
Leave blank for default
Help Entry
This is the web location that the browser will be redirected to if they navigate directly to the IP address in their browser, i.e. http://203.0.113.22/. If you chose a blank value, the request will display a "default" splash page. The files for the default splash page are at /var/www/html/. You can choose one of the domains on that IP address, or any other domain you prefer.
No
 Chapter 20: Controller: /nodeworx/ip Up Part II: NodeWorx API Spec Chapter 22: Controller: /nodeworx/ipv6 

(C) 2017 by InterWorx LLC