Schemas
These models describe how API requests and responses are shaped. Each one is linked from the endpoints that use it.
| Schema | Description | Endpoints |
|---|---|---|
AvailabilityResult |
— | 1 |
CaaGenerateInput |
Body for kind=caa. The single value “;” in issue forbids all certificate issuance. | 1 |
CaaGenerateResult |
— | 1 |
DkimResult |
When found=false, only api, domain, selector, name, found and status (DNS RCODE) are returned. | 1 |
DmarcGenerateInput |
Body for kind=dmarc. | 1 |
DmarcGenerateResult |
— | 1 |
DnssecResult |
— | 1 |
DomainHealth |
— | 1 |
Finding |
— | — |
GeneratedRecord |
— | — |
HeaderAnalysisResult |
— | 1 |
IdnResult |
— | 1 |
IssueCode |
Structured, machine-readable warning or error code (for example “too-many-lookups”), intentionally not display text so integrations can localize. | — |
LookupResult |
— | 1 |
MtaStsGenerateInput |
Body for kind=mta-sts. | 1 |
MtaStsGenerateResult |
— | 1 |
PropagationResult |
— | 1 |
SpfGenerateInput |
Body for kind=spf. | 1 |
SpfGenerateResult |
— | 1 |