Chapter 66: Controller: /siteworx/domains/php Up Part III: SiteWorx API Spec Chapter 68: Controller: /siteworx/domains/slave 

67 Controller: /siteworx/domains/pointer

Required Permissions "POINTERDOMS"
Required Options Pointer Domains
Action: add
Added in version 4.7.0-339
Description Add a pointer domain.
Input Parameters
Name Type Notes Required?
domain string Description
http://www.
Yes
redir_type string Example Values
redirect_301, redirect_302, server_alias
Example Default Value
redirect_301
No*
points_to string Example Values
example.com, secondary.com
Example Default Value
example.com
No*
create_mail_alias integer Help Entry
If selected, all mail accounts will work for both the pointer domain and target domain.
Example Values
1
Example Default Value
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: addMailPointerDomain
Added in version 4.7.0-339
Description Add a pointer domain for mail.
Input Parameters
Name Type Notes Required?
pointer_domain string Yes
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: delete
Added in version 4.7.0-339
Description Delete a pointer domain.
Input Parameters
Name Type Notes Required?
domain struct (string) Example Values
pointer.com
Yes
Action: deleteMailPointer
Added in version 4.7.0-339
Description Delete a pointer domain for mail.
Input Parameters
Name Type Notes Required?
pointer_domain string Example Values
pointer.com
Yes
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: fail
Added in version n/a
Description Magic function - test for failure mechanism.
Action: list
Added in version 4.7.0-339
Description List pointer domains.
Warning This action has been deprecated as of version 4.8.0-393. 2010-11-18 use listPointerDomains.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’pointer.com’,
),
)
Action: listPointerDomains
Added in version 4.8.0-393
Description List pointer domains.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’domain’ => ’pointer.com’,
’points_to’ => ’http://example.com’,
’type’ => ’redirect (301)’,
’mail_alias’ => ’##LG_YES##’,
),
),
)
Action: reroute
Added in version n/a
Description Action to re-route from the current controller to a different one.
Input Parameters
Name Type Notes Required?
controller string Example Values
Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, DomainsSlave, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Simplescripts, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpamprefs, EmailSpf, EmailDomainkeys, Backup, BackupSchedule, Prefs, Notice, Logout
Yes
Action: win
Added in version n/a
Description Magic function - test for testing success mechanism.
 Chapter 66: Controller: /siteworx/domains/php Up Part III: SiteWorx API Spec Chapter 68: Controller: /siteworx/domains/slave 

(C) 2018 by InterWorx LLC