Controller: Overview

API Controller	/siteworx/overview

Action	Description
editProfile	Edit the currently authenticated users' profile.
listAccountDetails	List siteworx account details.
listAvailableDiskSpace	List available disk space action.
listLicenseKey	List the InterWorx license key.
listMasterDomain	List the current master domain.
listPhpInstallMode	Get the mode php is running under.
listVersion	List the version of InterWorx installed.
listWorkingDomain	List the current working domain.
queryLegacyScriptworxInstallations	Query legacy scriptworx installations.

Action: editProfile (Added in version 4.8.3-415)

Edit the currently authenticated users' profile.

Input Parameters

Name	Type	Notes	Required?
language	string	Example Values cs, en-us, fr, de, hu, it, pl, pt, sk, es, sv, tr Example Default Value en-us	No*
menu_style	string	Example Values big, small Example Default Value small	No*
password	string		No
confirm_password	string	Help Entry Confirm the password field by providing it again. Must match the password provided.	No
* indicates that it's actually required, but probably already has a valid default value

Action: listAccountDetails

List siteworx account details.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    'username' => 'example',
    'email' => 'user@example.com',
    'masterdomain' => 'example.com',
    'homedir' => '/home/example',
    'domains' => 
    array (
      0 => 'example.com',
      1 => 'secondary.com',
    ),
    'remaining_diskspace' => 'unlimited',
    'options' => 
    array (
      'storage' => 999999999,
      'bandwidth' => 999999999,
      'email_aliases' => 999999999,
      'email_autoresponders' => 999999999,
      'email_boxes' => 999999999,
      'email_groups' => 999999999,
      'ftp_accounts' => 999999999,
      'mysql_dbs' => 999999999,
      'mysql_db_users' => 999999999,
      'pointer_domains' => 999999999,
      'slave_domains' => 999999999,
      'subdomains' => 999999999,
      'backup' => true,
      'cgi_access' => true,
      'crontab' => true,
      'dns_records' => true,
      'resolve_xferlog_dns' => true,
      'ssl' => true,
      'burstable' => true,
      'save_xfer_logs' => true,
    ),
  ),
)

Action: listAvailableDiskSpace

List available disk space action.

Example Output

array (
  'status' => 0,
  'payload' => 'unlimited',
)

Action: listLicenseKey (Added in version 4.2.0-260)

List the InterWorx license key.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    'licence_key' => 'INTERWORX_COS5_INST',
  ),
)

Action: listMasterDomain

List the current master domain.

Example Output

array (
  'status' => 0,
  'payload' => 'example.com',
)

Action: listPhpInstallMode

Get the mode php is running under.

Example Output

array (
  'status' => 0,
  'payload' => 'suphp',
)

Action: listVersion (Added in version 4.2.0-260)

List the version of InterWorx installed.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    'version' => '4.10.0-440',
  ),
)

Action: listWorkingDomain

List the current working domain.

Example Output

array (
  'status' => 0,
  'payload' => 'example.com',
)

Action: queryLegacyScriptworxInstallations

Query legacy scriptworx installations.

Input Parameters

Name	Type	Notes	Required?
scriptname	integer		No