Account Status API


The Account Status API allows you to query the current usage of your PasswordPing account.

Available Calls

  • GET Account Status
    Returns API usage stats for your account for the current billing period.

GET – Account Status

https://api.passwordping.com/account-status

Returns API usage stats for your account for the current billing period. Note that current usage numbers may be up to 5 minutes behind.

See Using PasswordPing for general instructions on using the API.

Request

No request parameters required.

Response

Response Description
200 The response contains current usage statistics.

Response Body

Member Type Description
monthlyAPICallLimit integer How many calls your account is allowed to make to the PasswordPing API every month
currentAPICallUsage integer How many calls have been made in the current billing period
exposureAlertsServiceMonitoredAccountsLimit integer How many email accounts your account is allowed to monitor for new exposures
exposureAlertsServiceCurrentMonitoredAccounts integer How many email accounts your account is currently monitoring for new exposures
exposureAlertsServiceMonitoredDomainsLimit integer How many email domains your account is allowed to monitor for new exposures
exposureAlertsServiceCurrentMonitoredDomains integer How many email domains your account is currently monitoring for new exposures

Example

Request
curl --header "authorization: basic {your auth string}" "https://api.passwordping.com/account-status"
Response
{ 
  "monthlyAPICallLimit": 500000,
  "currentAPICallUsage": 200635,
  "exposureAlertsServiceMonitoredAccountsLimit": 100,
  "exposureAlertsServiceCurrentMonitoredAccounts": 2,
  "exposureAlertsServiceMonitoredDomainsLimit": 3,
  "exposureAlertsServiceCurrentMonitoredDomains": 1
}