Skip to main content

GET /domains

GET 

domains

Retrieve all domains currently monitored for blocklist status and DKIM validation

Query Parameters​

offset string
Number of items to skip before starting to return results

limit string
Maximum number of items to return per request

sort string
Sort field and order (e.g., -domain for descending or domain for ascending)

profile_id string
Filter by profile ID

domain string
Filter by domain name substring

rdns string
Filter by reverse DNS substring

rbl_hosts string
Filter by RBL lookup host names (multiple values separated by comma allowed, e.g., truncate.gbudb.net,rbl.metunet.com). Get all available host names from /api/v1.0/epc/rbl_dictionary?type=domains

blacklisted boolean
Filter to show only blacklisted domains

Returns

  • dataarray
    • idstring
      Unique identifier of the domain
    • domainstring
      Domain name being monitored
    • dns_lookup_resultarray
      DNS lookup results containing resolved IP addresses
      • ipstring
        Resolved IP address for the domain
    • rbl_resultarray
      Blacklist check results from various RBL providers
      • lookup_hoststring
        RBL provider hostname that was queried
    • spfobject
      SPF record validation results and details
      • domainstring
        Domain against which the SPF record was evaluated
      • resultboolean
        Indicates whether the SPF check passed
      • dns_queries_to_resolvenumber
        Number of DNS queries required to fully resolve the SPF record
      • recordstring
        The raw SPF TXT record retrieved from DNS
      • warningsarray
        Non-critical issues found during SPF evaluation
      • mechanismsarray
        List of SPF mechanisms parsed from the record
        • mechanismstring
          The SPF mechanism
        • modifierstring
          The SPF modifier
        • dataobject
          The data associated with the mechanism
        • warningstring
          Warning message if an issue was detected with this mechanism
        • is_dns_query_to_resolveboolean
          Indicates whether this mechanism requires a DNS lookup
        • domainstring
          The domain associated with this mechanism
    • dkimarray
      DKIM configuration and validation results for all selectors
      • resultstring
        DKIM validation result
      • selectorstring
        DKIM selector used for public key lookup
      • errorsarray
        Critical errors found during DKIM validation
      • warningsarray
        Non-critical issues found during DKIM validation
    • dmarcobject
      DMARC policy validation results and configuration
      • resultarray
        DMARC evaluation result
      • warningsarray
        Non-critical issues found during DMARC evaluation
    • statusstring
      Current processing status of the domain
    • blacklistedboolean
      Indicates whether the domain is currently listed on at least one RBL
    • updated_atstring
      Timestamp when the domain information was last updated
  • metaobject
    Pagination metadata for list responses
    • countinteger
      Total number of items available
    • offsetinteger
      Number of items skipped
    • limitinteger
      Maximum number of items returned per request
Error Codes

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

500 Internal Server Error

Internal server error