Controller: DomainsPointer

API Controller /siteworx/domains/pointer
Required Permissions ["POINTERDOMS"]
Required Options Pointer Domains
Action Description
add Add a pointer domain.
addMailPointerDomain Add a pointer domain for mail.
delete Delete a pointer domain.
deleteMailPointer Delete a pointer domain for mail.
list List pointer domains. DEPRECATED in version 4.8.0-393
listPointerDomains List pointer domains.

Action: add

Add a pointer domain.

Input Parameters

Name Type Notes Required?
domain string
Description
http://www.
 Yes

Action: addMailPointerDomain (Added in version 4.3.0-290)

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

Delete a pointer domain.

Input Parameters

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

Action: deleteMailPointer (Added in version 4.3.0-290)

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: list

This action has been deprecated as of version 4.8.0-393.

MESSAGE: 2010-11-18 use listPointerDomains.

List pointer domains.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 'pointer.com',
  ),
)

Action: listPointerDomains (Added in version 4.8.0-393)

List pointer domains.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'domain' => 'pointer.com',
    ),
  ),
)