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

Added in Version

8.0.3-2553

Description

Edit settings for a subdomain

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
prefix	string	Yes	sub
document_root	string	No*		/home/example/example.com/html/sub	The root of the path to be served by the webserver for this domain. Any content below this directory will be available through the webserver.
use_parent_php	integer	No*	1, 0	0	Sets the subdomain to use the parent domain’s PHP version. If this is set to “Yes” the PHP version option below will be ignored.
php_version	string	No*	/opt/remi/php74, /opt/remi/php80, system-php	system-php

* indicates that it’s actually required, but probably already has a valid default value.

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',
      'document_root' => '/home/example/example.com/html/sub',
      'php_version' => '8.2.30',
      'php_is_system' => true,
      'use_parent_php' => false,
      'is_wildcard' => false,
    ),
  ),
  '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, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, DomainsAdvanced, 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: wait

Added in Version

8.1.3-2998

Description

Magic function - used to simulate a long-running process

Action: win

Added in Version

n/a

Description

Magic function - test for testing success mechanism.