Controller: /siteworx/domains/manage ==================================== :Required Permissions: SLAVEDOMS Action: ``add`` --------------- :Added in Version: 7.0.0-1753 :Description: Add a secondary domain. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - - - * - ``php_version`` - string - No* - /opt/remi/php74, /opt/remi/php80, system-php - system-php - * - ``ipv4`` - string - No* - 192.168.0.1, 192.168.0.3 - 192.168.0.3 - * - ``ipv6`` - integer - No* - 0 - 0 - * - ``ipv6_from_pool`` - string - No - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``delete`` ------------------ :Added in Version: 7.0.0-1753 :Description: Delete a secondary domain. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - struct (string) - Yes - example.com, secondary.com - - * - ``force_delete_domroot`` - integer - No - 1 - - Action: ``deleteConfig`` ------------------------ :Added in Version: 7.0.0-1753 :Description: Delete Domain Level Config Data. .. warning:: This action has been deprecated as of version 4.8.0-393. 2019-11-07 Use deleteDomainConfigCommit on Ctrl_Nodeworx_Siteworx Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, secondary.com - - * - ``config_name`` - struct (string) - No* - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``edit`` ---------------- :Added in Version: 7.0.0-1753 :Description: Edit a secondary domain. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, secondary.com - - * - ``php_version`` - string - No* - /opt/remi/php74, /opt/remi/php80, system-php - system-php - * - ``document_root`` - string - No* - - /home/example/example.com/html - 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. * - ``ipv4`` - string - No* - 192.168.0.1, 192.168.0.3 - 192.168.0.3 - * - ``ipv6`` - integer - No* - 0 - 0 - * - ``ipv6_from_pool`` - string - No - - - \* 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: 7.0.0-1753 :Description: List secondary domains. .. warning:: This action has been deprecated as of version 4.8.0-393. 2010-11-18 use listSecondaryDomains Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => 'example.com', 1 => 'secondary.com', ), 'reply_code' => 205, ) Action: ``listConfig`` ---------------------- :Added in Version: 7.0.0-1753 :Description: List all SiteWorx Level Config Data. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, secondary.com - - Action: ``listIds`` ------------------- :Added in Version: 7.0.0-1753 :Description: List secondary domains by id. .. warning:: This action has been deprecated as of version 4.8.0-393. 2010-11-18 no longer servers any real purpose, will be removed. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => '4', 1 => 'secondary.com', ), ), 'reply_code' => 205, ) Action: ``listSecondaryDomains`` -------------------------------- :Added in Version: 7.0.0-1753 :Description: List master domain and secondary domains. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'domain' => 'example.com', 'type' => 'master', 'php_version' => '8.1.31', 'php_is_system' => true, 'ipv4' => '192.168.0.3', 'ipv6' => false, 'document_root' => '/home/example/example.com/html', 'ipv4_type' => '##LG_SHARED##', 'ipv4_ssl' => array ( 0 => 'example.com', 1 => 'sub.example.com', ), 'ipv6_type' => '', 'ipv6_ssl' => '', ), 1 => array ( 'domain' => 'secondary.com', 'type' => 'slave', 'php_version' => '8.1.31', 'php_is_system' => true, 'ipv4' => '192.168.0.3', 'ipv6' => false, 'document_root' => '/home/example/secondary.com/html', 'ipv4_type' => '##LG_SHARED##', 'ipv4_ssl' => array ( 0 => 'example.com', 1 => 'sub.example.com', ), 'ipv6_type' => '', 'ipv6_ssl' => '', ), ), 'reply_code' => 205, ) Action: ``queryConfig`` ----------------------- :Added in Version: 7.0.0-1753 :Description: Query Domain Level Config Data. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, secondary.com - - * - ``config_name`` - string - Yes - - - Action: ``queryEdit`` --------------------- :Added in Version: 7.0.0-1753 :Description: Displays the information available to the action "edit". Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, secondary.com - - Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'domain_copy' => 'example.com', 'php_version' => 'system-php', 'document_root' => '/home/example/example.com/html', 'ipv4' => '192.168.0.3', 'ipv6' => '0', 'ipv6_from_pool' => NULL, 'domain' => 'example.com', ), '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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - 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: ``setConfig`` --------------------- :Added in Version: 7.0.0-1753 :Description: Set Domain Level Config Data. .. warning:: This action has been deprecated as of version 4.8.0-393. 2019-11-07 Use setDomainConfigCommit on Ctrl_Nodeworx_Siteworx Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, secondary.com - - * - ``config_name`` - struct (string) - No* - - - * - ``config_value`` - struct (string) - No - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``setDirectoryIndex`` ----------------------------- :Added in Version: 8.0.3-2553 :Description: Set the directory index Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``directory_index`` - struct (string) - No - - ["index.php","index.html"] - A list of resources/files to look for when the client requests a URL without specifying a specific filename. The first found match found is the file loaded. Action: ``setPhpExtensions`` ---------------------------- :Added in Version: 7.11.0-2082 :Description: Set a list of file extensions that should be processed by PHP. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, secondary.com - - * - ``php_file_extensions`` - struct (string) - No* - - ["php"] - A list of file extensions that may contain PHP and should be processed by PHP. Do not include a period before the extension. \* indicates that it's actually required, but probably already has a valid default value. Action: ``setWebmasterEmail`` ----------------------------- :Added in Version: 8.0.3-2553 :Description: Set the server admin field in the vhost for a domain Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, secondary.com - - * - ``webmaster_email`` - string - No* - - webmaster@example.com - The email address of the webmaster of this website. This will appear on some error pages to provide users with contact information to report issues. \* indicates that it's actually required, but probably already has a valid default value. Action: ``win`` --------------- :Added in Version: n/a :Description: Magic function - test for testing success mechanism.