Note

You are viewing the documentation for an older release of Interworx (8.0). To see documentation for the current generally available release of Interworx, click here: 8.2.

Controller: /siteworx/domains/php

Required Permissions

PHP

Action: edit

Added in Version

6.0.16-1398

Description

Edit PHP options.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
domain	string	Yes	sub.example.com, secondary.com, example.com
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: listFpmOptions

Added in Version

6.0.27-1423

Description

Show FPM options for this SiteWorx account.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    'fpm_max_children' => '4',
    'fpm_max_requests' => '8192',
    'fpm_process_management' => 'ondemand',
    'fpm_start_servers' => '2',
    'fpm_min_spare_servers' => '1',
    'fpm_max_spare_servers' => '4',
    'fpm_process_idle_timeout' => '120s',
  ),
  'reply_code' => 205,
)

Action: listPhpVersions

Added in Version

6.0.27-1423

Description

List php versions for master and secondary domains.

Sample Output

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' => '',
    ),
    2 =>
    array (
      'domain' => 'sub.example.com',
      'prefix' => 'sub',
      'document_root' => '/home/example/example.com/html/sub',
      'php_version' => '8.1.31',
      'use_parent_php' => 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: setDefaultPhp

Added in Version

7.12.4-2265

Description

Set default php version.

Input Parameters

Name	Type	Required?	Example Values	Default Values	Notes
default_php_version	string	No*	/opt/remi/php74, /opt/remi/php80, system-php	system-php	This version will be pre-selected when creating new SiteWorx accounts. This controls the default value when using an API call that may not provide this input for creating a new SiteWorx Account.

* 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.