Constructor
new Servers(config)
Parameters:
| Name |
Type |
Description |
config |
Object
|
Object containing your API credentials.
Properties
| Name |
Type |
Attributes |
Description |
serverUrl |
string
|
|
URL to your installation. Remember to point to /includes/api.php |
username |
string
|
<optional>
|
|
password |
string
|
<optional>
|
|
identifier |
string
|
<optional>
|
|
secret |
string
|
<optional>
|
|
|
- Source:
Extends
Methods
getHealthStatus(opts)
Get health status. - https://developers.whmcs.com/api-reference/gethealthstatus/
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
fetchStatus |
Boolean
|
<optional>
|
Pass as true to attempt to fetch server status values. |
|
- Source:
getServers(opts)
Get servers. - https://developers.whmcs.com/api-reference/getservers/
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
fetchStatus |
Boolean
|
<optional>
|
Pass as true to attempt to fetch server status values. |
|
- Source: