Domain Master

List of chapters

• 1 Getting Started
• 2 Master API Usage Examples
• 3 Master API PHP Client
• 4 Commands
• 5 Appendices

Master API Documentation → Other Commands → Master API Limits Information - hitpoint info

Master API Limits Information - hitpoint info

Returns an array containing the current and maximum Master API usage limits.

Example:

<?php
$result = $client->sendCommand("hitpoint info");
echo("<pre>");
print_r($result->getData());
echo("</pre>");
/* Output:
Array
(
    ["current_command_count"] => string(2) "59"
    ["max_commands_allowed_this_month"] => string(5) "18400"
    ["current_hitpoints_this_month"] => string(1) "0"
    ["max_allowed_hitpoints_per_month"] => string(4) "1000"
    ["current_hitpoints_this_hour"] => string(1) "0"
    ["max_allowed_hitpoints_per_hour"] => string(2) "10"
)
?>
*/

Value Description

• currentcommandcount: Total number of commands used during the current month.
• maxcommandsallowedthismonth: Maximum number of commands allowed during the current month. Exceeding this limit results in throttling until the end of the month.
• currenthitpointsthis_month: Total number of errors during the current month.
• maxallowedhitpointspermonth: Maximum number of errors allowed during the current month. Exceeding this limit results in blocking until the end of the month.
• currenthitpointsthis_hour: Total number of errors during the current hour.
• maxallowedhitpointsperhour: Maximum number of errors allowed during the current hour. Exceeding this limit results in blocking until the end of the current hour.