Query Breach Alert Subscriptions for Domains

Retrieve Exposure alert subscriptions for domains

Returns a paginated list of all domain alert subscriptions for your account. Can be used to check if a specific domain is monitored by using the domain parameter.

get

/breach-monitoring-for-domains

Authorizations

Query parameters

domainstring

(Optional) If specified, the call will only check to see if this domain is monitored. If this parameter is not provided, the call will instead return a list of all domains being monitored for your account.

customDatastring

(Optional) If specified, the call will return a list of all domains being monitored for your account that were originally added with this customData value.

pageSizeinteger

(Optional) The number of results to return in a single call

pagingTokenstring

(Optional) For each call to the API, if there are more pages of results available then a pagingToken will be returned. Pass the pagingToken in via this parameter to retrieve the subsequent page of results. Should be left off for the initial call to the API.

includeWebhookInfoboolean

(Optional) If this parameter is specified and true, the results will include the webhook information for each domain.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.enzoic.com/v1/breach-monitoring-for-domains' \
  --header 'Authorization: Basic username:password'

200

404

200

{
  "count": 1,
  "pagingToken": "5854757a7750ac6c4230f656",
  "domains": [
    {
      "domain": "sample.tst",
      "webhookID": "66766957431c9acc8cea2d6d",
      "webhookURL": "https://mywebhook.com",
      "customData": "customerDomain1"
    }
  ]
}

The response body contains the requested results.