Controller: MysqlRemote

API Controller /nodeworx/mysql/remote
Required Permissions ["MYSQL"]
Action Description
activate Reactivate a mysql server if it has gone offline.
add Add a new mysql server to the pool.
default Sets the default mysql server to use for new SiteWorx accounts and resellers.
listActiveServers List active MySQL servers.
listDeletableServers List deletable MySQL servers.
listInactiveServers List inactive MySQL servers.
listServers Lists the available mysql servers.
nickname Change a mysql server's nickname.
rootpass Change the given MySQL Server's root password.

Action: activate (Added in version 4.8.0-393)

Reactivate a mysql server if it has gone offline.

Input Parameters

Name Type Notes Required?
server string
Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
 Yes
root_username string
Help Entry
The root username of the MySQL Server. Note: this is *not* the system root username.
 Yes
root_password string
Help Entry
The root password of the MySQL Server. Note: this is *not* the system root password.
 Yes

Action: add (Added in version 4.8.0-393)

Add a new mysql server to the pool.

Input Parameters

Name Type Notes Required?
nickname string Yes
host string
Help Entry
Enter the host or IP address (with port if needed) of the database server.
 Yes
root_username string
Help Entry
The root username of the MySQL Server. Note: this is *not* the system root username.
 Yes
root_password string
Help Entry
The root password of the MySQL Server. Note: this is *not* the system root password.
 Yes

Action: default (Added in version 4.8.0-393)

Sets the default mysql server to use for new SiteWorx accounts and resellers.

Action: listActiveServers (Added in version 4.8.0-393)

List active MySQL servers.

Example Output

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

Action: listDeletableServers (Added in version 4.8.0-393)

List deletable MySQL servers.

Example Output

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

Action: listInactiveServers (Added in version 4.8.0-393)

List inactive MySQL servers.

Example Output

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

Action: listServers (Added in version 4.8.0-393)

Lists the available mysql servers.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'server_id' => '1',
      'nickname' => 'localhost',
      'can_delete' => false,
      'version' => '5.0.95',
      'host' => '208.69.122.234',
      'is_running' => true,
      'can_connect' => true,
      'is_local' => true,
    ),
  ),
)

Action: nickname (Added in version 4.8.0-393)

Change a mysql server's nickname.

Input Parameters

Name Type Notes Required?
server string
Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
 Yes

Action: rootpass (Added in version 4.8.0-393)

Change the given MySQL Server's root password.

Input Parameters

Name Type Notes Required?
server string
Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
 Yes
password string Yes
confirm_password string
Help Entry
Confirm the password field by providing it again. Must match the password provided.
 Yes