Chapter 68: Controller: /siteworx/domains/slave Up Part III: SiteWorx API Spec Chapter 70: Controller: /siteworx/email 

69 Controller: /siteworx/domains/sub

Required Permissions "SUBDOMAINS"
Required Options Subdomains
Action: add
Added in version 4.7.0-339
Description Add a subdomain.
Input Parameters
Name Type Notes Required?
prefix string Yes
Action: delete
Added in version 4.7.0-339
Description Delete a subdomain.
Input Parameters
Name Type Notes Required?
prefix struct (string) Example Values
sub
Yes
delete_dir integer 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 subdomains.
Warning This action has been deprecated as of version 4.8.0-393. 2010-11-18 use listSubdomains instead.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’sub’,
1 => ’sub.example.com’,
),
),
)
Action: listSubdomains
Added in version 4.8.0-393
Description List subdomains.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’domain’ => ’sub.example.com’,
’prefix’ => ’sub’,
),
),
)
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 68: Controller: /siteworx/domains/slave Up Part III: SiteWorx API Spec Chapter 70: Controller: /siteworx/email 

(C) 2018 by InterWorx LLC