SPF-, DMARC-, CAA- oder MTA-STS-Records erzeugen

POST /api/v1/generate/{kind}

Reine Record-Baukästen, keine DNS-Abfragen. Warnungen und Fehler kommen als strukturierte, maschinenlesbare Codes zurück (zum Beispiel “too-many-lookups”), nie als Anzeigetext; das ist Absicht, damit Integrationen sie lokalisieren können.

Pfad-Parameter

Name	Typ	Pflicht	Beschreibung
kind	string	ja	—

Request Body

Dazu die Felder einer der folgenden Varianten:

Variante	Felder
SpfGenerateInput	allowA: boolean, allowMx: boolean, ip4: string[], ip6: string[], includes: string[], all: string
DmarcGenerateInput	policy: string, subdomainPolicy: string, rua: string[], ruf: string[], pct: integer, adkim: string, aspf: string, fo: string, domain: string
CaaGenerateInput	issue: string[], issuewild: string[], iodef: string, critical: boolean
MtaStsGenerateInput	domain: string, mode: string, mx: string[], maxAgeDays: integer, id: string, tlsRptEmail: string

Antworten

Status	Typ	Beschreibung
200	SpfGenerateResult | DmarcGenerateResult | CaaGenerateResult | MtaStsGenerateResult	Erzeugte Record(s), Struktur abhängig von kind
400	object	Fehler
405	object	Fehler
429	object	Fehler

Antwortkörper

Feld	Typ	Pflicht	Beschreibung
api	string	nein	—
kind	string	nein	—
warnings	IssueCode[]	nein	—

Dazu die Felder einer der folgenden Varianten:

Variante	Felder
SpfGenerateResult	host: string, type: string, record: string, lookupCount: integer, errors: IssueCode[]
DmarcGenerateResult	host: string, type: string, record: string, errors: IssueCode[]
CaaGenerateResult	records: GeneratedRecord[]
MtaStsGenerateResult	dnsRecord: GeneratedRecord, policyFile: string, policyUrl: string, tlsRptRecord: GeneratedRecord

Beispiel

curl -X POST "https://dns-doctor.com/api/v1/generate/<kind>" \
  -H "Authorization: Bearer $REGFISH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "allowA": true,
    "allowMx": true,
    "ip4": [
      "string"
    ],
    "ip6": [
      "string"
    ],
    "includes": [
      "string"
    ],
    "all": "softfail"
  }'

Anfrage zusammenstellen

Werte eintragen — der Aufruf unten passt sich an. Es wird nichts abgeschickt: die API gibt Browser-Anfragen von dieser Domain aus derzeit nicht frei (CORS). Der API-Key wird nicht gespeichert.