Query Breach Alert Subscriptions for Domains

Retrieve Exposure alert subscriptions for domains

get

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.

Authorizations

Query parameters

domainstringOptional

(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.

customDatastringOptional

(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.

pageSizeintegerOptional

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

pagingTokenstringOptional

(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.

includeWebhookInfobooleanOptional

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

Responses

200

The response body contains the requested results.

application/json

404

Returned when the domain parameter is used to indicate that an alert subscription does not exist for the provided domain.

get

HTTPcURLJavaScriptPython

GET /v1/breach-monitoring-for-domains HTTP/1.1
Host: api.enzoic.com
Authorization: Bearer Base64(your_api_key:your_api_secret)
Accept: */*

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