Chapter 38: Controller: /nodeworx/mysql Up Part II: NodeWorx API Spec Chapter 40: Controller: /nodeworx/nfs 

39 Controller: /nodeworx/mysql/remote

Required Permissions "MYSQL"
Action: activate
Added in version 4.8.0-393
Description 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
Description 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
Description Sets the default mysql server to use for new SiteWorx accounts and resellers.
Action: listActiveServers
Added in version 4.8.0-393
Description List active MySQL servers.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’localhost’,
),
)
Action: listDeletableServers
Added in version 4.8.0-393
Description List deletable MySQL servers.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)
Action: listInactiveServers
Added in version 4.8.0-393
Description List inactive MySQL servers.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)
Action: listServers
Added in version 4.8.0-393
Description Lists the available mysql servers.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’server_id’ => ’1’,
’nickname’ => ’localhost’,
’can_delete’ => false,
’version’ => ’5.1.73’,
’host’ => ’10.1.15.200’,
’is_running’ => true,
’can_connect’ => true,
’is_local’ => true,
),
),
)
Action: nickname
Added in version 4.8.0-393
Description 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: queryDefault
Added in version 5.1.0-838
Description Displays the information available to the action "default".
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
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’server_copy’ => ’localhost’,
’server’ => ’localhost’,
),
)
Action: queryProcesses
Added in version 4.8.0-393
Description Query processes on the local mysql server.
Input Parameters
Name Type Notes Required?
server string Example Values
localhost
Yes
Action: rootpass
Added in version 4.8.0-393
Description 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
 Chapter 38: Controller: /nodeworx/mysql Up Part II: NodeWorx API Spec Chapter 40: Controller: /nodeworx/nfs 

(C) 2017 by InterWorx LLC