Skip to content

Schemas

These models describe how API requests and responses are shaped. Each one is linked from the endpoints that use it.

SchemaDescriptionEndpoints
AvailabilityResult-1
CaaGenerateInputBody for kind=caa. The single value ”;” in issue forbids all certificate issuance.1
CaaGenerateResult-1
DkimResultWhen found=false, only api, domain, selector, name, found and status (DNS RCODE) are returned.1
DmarcGenerateInputBody for kind=dmarc.1
DmarcGenerateResult-1
DnssecResult-1
DomainHealth-1
Finding--
GeneratedRecord--
HeaderAnalysisResult-1
IdnResult-1
IssueCodeStructured, machine-readable warning or error code (for example “too-many-lookups”), intentionally not display text so integrations can localize.-
LookupResult-1
MtaStsGenerateInputBody for kind=mta-sts.1
MtaStsGenerateResult-1
PropagationResult-1
SpfGenerateInputBody for kind=spf.1
SpfGenerateResult-1