API Reference
DomainSummary
Represents condensed results of domain health checks.
Inheritance
- Object
- DomainSummary
Remarks
This model is suited for displaying a quick overview or change detection between subsequent analyses.
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method DomainHealthCheck.BuildSummary
- Property DomainHealthCheck.Summary
- Property MonitorScheduler.SummaryOverride
- Property DomainOverallInfo.Summary
- Property DomainOverviewInfo.Summary
Examples
Inspect WHOIS expiration details.
var health = new DomainHealthCheck();
await health.Verify("example.com");
var summary = health.BuildSummary();
Console.WriteLine($"Expires on {summary.ExpiryDate} in {summary.DaysUntilExpiration} days");
Constructors
public DomainSummary() #Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public Boolean HasSpfRecord { get; set; } #Indicates whether the domain has an SPF record.
public Boolean SpfValid { get; set; } #Indicates whether the SPF record appears valid.
public Boolean HasDmarcRecord { get; set; } #Indicates whether the domain has a DMARC record.
public String DmarcPolicy { get; set; } #Policy configured in the DMARC record.
public Boolean DmarcValid { get; set; } #True when the DMARC record appears valid.
public Boolean HasDkimRecord { get; set; } #Indicates whether a DKIM record exists.
public Boolean DkimValid { get; set; } #True when at least one DKIM record appears valid.
public Boolean HasMxRecord { get; set; } #Indicates whether MX records exist.
public Boolean DnsSecValid { get; set; } #True when DNSSEC validation succeeded.
public Boolean DnsSecKeyExpiresSoon { get; set; } #True when DNSSEC keys expire soon.
public Boolean IsPublicSuffix { get; set; } #Indicates whether the analyzed domain is itself a public suffix as defined by https://datatracker.ietf.org/doc/html/rfc8499 RFC 8499.
public String ExpiryDate { get; set; } #Expiration date reported by WHOIS.
public Nullable<Int32> DaysUntilExpiration { get; set; } #Number of days until expiration; negative when already expired.
public Boolean ExpiresSoon { get; set; } #True when the domain expires soon.
public Boolean IsExpired { get; set; } #True when the domain is past its expiration date.
public Boolean RegistrarLocked { get; set; } #True when registrar lock is enabled.
public Boolean PrivacyProtected { get; set; } #True when WHOIS data is privacy protected.
public IReadOnlyList<String> Hints { get; set; } #Collection of recommended remediation hints.