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	Required?	Example Values	Default Values	Notes
domain	string	Yes
redir_type	string	No*	redirect_301, redirect_302, server_alias	redirect_301
points_to	string	No*	example.com, secondary.com	example.com
create_mail_alias	integer	No	1	1	If selected, all mail accounts will work for both the pointer domain and target domain.

* 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	Required?	Example Values	Default Values	Notes
pointer_domain	string	Yes
cascade_to_nodes	integer	No	1		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

Action: delete

Added in Version

4.7.0-339

Description

Delete a pointer domain.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
domain	struct (string)	Yes	pointer.com

Action: deleteMailPointer

Added in Version

4.7.0-339

Description

Delete a pointer domain for mail.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
pointer_domain	string	Yes	pointer.com
cascade_to_nodes	integer	No	1		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

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',
  ),
  'reply_code' => 205,
)

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##',
    ),
  ),
  'reply_code' => 205,
)

Action: reroute

Added in Version

n/a

Description

Action to re-route from the current controller to a different one.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
controller	string	Yes	Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, EmailMailman, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout

Action: win

Added in Version

n/a

Description

Magic function - test for testing success mechanism.