Get Monitored HBLs

Request

Gets all HBL entities that are being monitored

Security

basicAuth

Query

domainstring

Filter by domain

hbl_typestring

Filter by HBL type

entitystring

Filter by HBL entity (e.g. an email address); the hbl_type must be provided, too

include_subaccountsboolean

Include subaccounts

Default:false

limitintegerrequired

Limits the number of items returned in a request

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v1/monitoring/hbls?domain=string&hbl_type=string&entity=string&include_subaccounts=false&limit=0'

Responses

A 200 response

Bodyapplication/json

itemsArray of objects(Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-internal-model-HBLHealthRecord)required

pagingobject(Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-internal-api-PagingResponse)required

Response

{
  "items": [
    { … },
    { … }
  ],
  "paging": {}
}