Retrieve a System Configuration Value.
| Parameter | Type | Description | Required |
|---|---|---|---|
| action | string | "GetConfigurationValue" | Required |
| setting | string | The name of the setting to be obtained | Required |
| Parameter | Type | Description |
|---|---|---|
| result | string | The result of the operation: success or error |
| setting | string | The setting name |
| value | string | The setting value |
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
http_build_query(
array(
'action' => 'GetConfigurationValue',
// See https://developers.whmcs.com/api/authentication
'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
'password' => 'SECRET_OR_HASHED_PASSWORD',
'setting' => 'SystemURL',
'responsetype' => 'json',
)
)
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);$command = 'GetConfigurationValue';
$postData = array(
'setting' => 'SystemURL',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later
$results = localAPI($command, $postData, $adminUsername);
print_r($results);{
"result": "success",
"setting": "SystemURL",
"value": "http:\/\/www.example.com\/whmcs\/"
}Possible error condition responses include:
- Parameter setting is required
- Invalid name for parameter setting
| Version | Changelog |
|---|---|
| 7.0.0-beta.1 | Initial Version |