Chapter 64: Controller: /siteworx/domains/pointer Up Part III: SiteWorx API Spec Chapter 66: Controller: /siteworx/domains/sub 

65 Controller: /siteworx/domains/slave

Required Permissions "SLAVEDOMS"
Required Options Secondary Domains
Action: add
Added in version 4.7.0-339
Description Add a secondary domain.
Input Parameters
Name Type Notes Required?
domain string Description
http://www.
Yes
php_version string Help Entry
####
Example Values
/opt/remi/php71
Example Default Value
/opt/remi/php71
No*
ipv4 string Example Values
10.1.15.100, 10.1.15.101
Example Default Value
10.1.15.100
No*
ipv6 integer Example Default Value
0
No*
ipv6_from_pool string No
* indicates that it’s actually required, but probably already has a valid default value
Action: delete
Added in version 4.7.0-339
Description Delete a secondary domain.
Input Parameters
Name Type Notes Required?
domain struct (string) Example Values
secondary.com
Yes
Action: edit
Added in version 5.0.14-579
Description Edit a secondary domain.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, secondary.com
Yes
php_version string Help Entry
####
Example Values
/opt/remi/php71
Example Default Value
/opt/remi/php71
No*
ipv4 string Example Values
10.1.15.100, 10.1.15.101
Example Default Value
10.1.15.100
No*
ipv6 integer Example Default Value
0
No*
ipv6_from_pool string No
* indicates that it’s actually required, but probably already has a valid default value
Action: list
Added in version 4.7.0-339
Description List secondary domains.
Warning This action has been deprecated as of version 4.8.0-393. 2010-11-18 use listSecondaryDomains
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’example.com’,
1 => ’secondary.com’,
),
)
Action: listIds
Added in version 4.7.0-339
Description List secondary domains by id.
Warning This action has been deprecated as of version 4.8.0-393. 2010-11-18 no longer servers any real purpose, will be removed.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’789’,
1 => ’secondary.com’,
),
),
)
Action: listSecondaryDomains
Added in version 4.8.0-393
Description List master domain and secondary domains.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’domain’ => ’example.com’,
’type’ => ’master’,
’php_version’ => ’7.1.10’,
’ipv4’ => ’10.1.15.100’,
’ipv6’ => false,
’ipv4_type’ => ’##LG_SHARED##’,
’ipv4_ssl’ => ’example.com’,
’ipv6_type’ => ’’,
’ipv6_ssl’ => ’’,
),
1 =>
array (
’domain’ => ’secondary.com’,
’type’ => ’slave’,
’php_version’ => ’7.1.10’,
’ipv4’ => ’10.1.15.100’,
’ipv6’ => false,
’ipv4_type’ => ’##LG_SHARED##’,
’ipv4_ssl’ => ’example.com’,
’ipv6_type’ => ’’,
’ipv6_ssl’ => ’’,
),
),
)
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, secondary.com
Yes
Sample output
array (
’status’ => 11,
’payload’ => ’There was a problem validating the form. Please see details below.
ipv4: "10.1.15.100" This is not a valid option
Usage:
domain
php_version /opt/remi/php71
ipv4
ipv6 0
ipv6_from_pool’,
)
 Chapter 64: Controller: /siteworx/domains/pointer Up Part III: SiteWorx API Spec Chapter 66: Controller: /siteworx/domains/sub 

(C) 2017 by InterWorx LLC