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
AvailabilityResult1
CaaGenerateInputBody for kind=caa. The single value ”;” in issue forbids all certificate issuance.1
CaaGenerateResult1
DkimResultWhen found=false, only api, domain, selector, name, found and status (DNS RCODE) are returned.1
DmarcGenerateInputBody for kind=dmarc.1
DmarcGenerateResult1
DnssecResult1
DomainHealth1
Finding
GeneratedRecord
HeaderAnalysisResult1
IdnResult1
IssueCodeStructured, machine-readable warning or error code (for example “too-many-lookups”), intentionally not display text so integrations can localize.
LookupResult1
MtaStsGenerateInputBody for kind=mta-sts.1
MtaStsGenerateResult1
PropagationResult1
SpfGenerateInputBody for kind=spf.1
SpfGenerateResult1