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

Required?

Example Values

Default Values

Notes

prefix

string

Yes

Action: delete

Added in Version

4.7.0-339

Description

Delete a subdomain.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

prefix

struct (string)

Yes

sub

delete_dir

integer

No

1

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

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',
    ),
  ),
  '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, EmailSpamprefs, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout

Action: win

Added in Version

n/a

Description

Magic function - test for testing success mechanism.