Das DNS einer Domain einrichten
Ob OpenEmail die Einträge einer Domain selbst schreibt, über welche verbundene Zone und wo jede Art von Eintrag steht.
Führt jeden der 3 Aufrufe in Ihrem Workspace aus.
GET /domains/{id}/dns
Ob OpenEmail die Einträge einer Domain selbst schreibt, über welche verbundene Zone und wo jede Art von Eintrag steht.
Die Einrichtung lesen
Erfordert domains:read. managing ist true, solange OpenEmail die Einträge selbst schreibt. zone sagt, welche verbundene Zone für die Domain antwortet: Eine einzige ergibt resolved, mehrere ergeben ambiguous und brauchen eine Auswahl, keine hält sie (none), oder die Verbindungen ließen sich nicht befragen (unusable). Fügen Sie ?refresh=true hinzu, um die Anbieter erneut zu fragen.
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/dns" -H "$AUTH"{ "object": "domain_dns", "domainId": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f", "domain": "acme.com", "managing": true, "connectionId": "dnsl_3f9a1c2e7b4d4e6f8a0b2c3d", "connection": { "id": "dnsl_3f9a1c2e7b4d4e6f8a0b2c3d", "status": "active", "subject": "[email protected]", "accounts": [{ "id": "4f1c2b3a5d6e7f8091a2b3c4d5e6f708", "name": "Acme" }] }, "zoneId": "023e105f4ecef8ad9ca31a8372d0c353", "zoneName": "acme.com", "zoneHolder": "Acme", "state": "ready", "steps": [ { "purpose": "mx", "ok": true, "detail": "MX records are in place.", "visibility": "public", "records": [] } ], "leftovers": [], "probe": null, "error": null, "syncedAt": "2026-09-30T08:01:12.000Z", "zone": { "kind": "resolved", "checkedAt": "2026-10-01T09:00:00.000Z", "cached": true, "candidate": { "connectionId": "dnsl_3f9a1c2e7b4d4e6f8a0b2c3d", "subject": "[email protected]", "status": "active", "accounts": [{ "id": "4f1c2b3a5d6e7f8091a2b3c4d5e6f708", "name": "Acme" }], "account": { "id": "4f1c2b3a5d6e7f8091a2b3c4d5e6f708", "name": "Acme" }, "zone": { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "acme.com", "accountId": "4f1c2b3a5d6e7f8091a2b3c4d5e6f708", "active": true, "status": "active", "type": "full", "nameServers": ["ana.ns.cloudflare.com", "bob.ns.cloudflare.com"], "covers": true } }, "candidates": [], "reason": null, "connected": null, "host": null, "blocked": [] }}leftovers listet Einträge, die OpenEmail geschrieben hat und nicht zurücknehmen konnte, damit Sie sie beim Anbieter von Hand löschen.
Die Zone wählen
Erfordert domains:write. PUT /domains/{id}/dns mit { connectionId, zoneId } hängt die Domain an eine Zone, wenn mehrere für sie antworten könnten. Die Zone muss die Domain abdecken, aktiv sein und einen Testeintrag annehmen. Noch wird nichts geschrieben.
curl -X PUT "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/dns" -H "$AUTH" \ -H "Content-Type: application/json" \ -d '{ "connectionId": "dnsl_3f9a1c2e7b4d4e6f8a0b2c3d", "zoneId": "023e105f4ecef8ad9ca31a8372d0c353" }'{ "object": "domain_dns", "domainId": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f", "domain": "acme.com", "managing": true, "connectionId": "dnsl_3f9a1c2e7b4d4e6f8a0b2c3d", "connection": { "id": "dnsl_3f9a1c2e7b4d4e6f8a0b2c3d", "status": "active", "subject": "[email protected]", "accounts": [{ "id": "4f1c2b3a5d6e7f8091a2b3c4d5e6f708", "name": "Acme" }] }, "zoneId": "023e105f4ecef8ad9ca31a8372d0c353", "zoneName": "acme.com", "zoneHolder": "Acme", "state": "awaiting-sync", "steps": [ { "purpose": "mx", "ok": true, "detail": "MX records are in place.", "visibility": "public", "records": [] } ], "leftovers": [], "probe": null, "error": null, "syncedAt": "2026-09-30T08:01:12.000Z", "zone": { "kind": "resolved", "checkedAt": "2026-10-01T09:00:00.000Z", "cached": true, "candidate": { "connectionId": "dnsl_3f9a1c2e7b4d4e6f8a0b2c3d", "subject": "[email protected]", "status": "active", "accounts": [{ "id": "4f1c2b3a5d6e7f8091a2b3c4d5e6f708", "name": "Acme" }], "account": { "id": "4f1c2b3a5d6e7f8091a2b3c4d5e6f708", "name": "Acme" }, "zone": { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "acme.com", "accountId": "4f1c2b3a5d6e7f8091a2b3c4d5e6f708", "active": true, "status": "active", "type": "full", "nameServers": ["ana.ns.cloudflare.com", "bob.ns.cloudflare.com"], "covers": true } }, "candidates": [], "reason": null, "connected": null, "host": null, "blocked": [] }}Eine Zone, die die Domain nicht abdeckt, ist ein 422 invalid_parameter auf zoneId. Eine Domain, die über eine andere Zone eingerichtet ist, ergibt 409 dns_zone_conflict, und eine Zone, die nicht aktiv ist oder den Testeintrag ablehnt, ergibt 409 dns_zone_unusable.
Ein OAuth-Zugriffstoken braucht für diesen Aufruf einen Bestätigungscode. Solange die App in den letzten 60 Minuten keinen bestätigt hat, antwortet der Aufruf mit 403 step_up_required und ändert nichts. Ein API-Schlüssel wird nie gefragt. Die Seite Authentifizierung zeigt, wie Sie einen Code anfordern und bestätigen.
Die Einträge schreiben
Erfordert domains:write. POST /domains/{id}/dns/sync schreibt oder repariert jeden Eintrag, den die Domain braucht, wie Sync in der App, und hängt zuerst die Zone an, wenn nur eine antwortet. Senden Sie { "purpose": "dmarc" }, um nur eine Art von Eintrag zu schreiben.
curl -X POST "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/dns/sync" -H "$AUTH"{ "object": "domain_dns_sync", "outcome": "synced", "message": null, "attached": false, "provision": { "outcome": "applied", "state": "ready", "connectionId": "dnsl_3f9a1c2e7b4d4e6f8a0b2c3d", "zoneId": "023e105f4ecef8ad9ca31a8372d0c353", "proven": true, "ownership": "The ownership record is in place.", "written": [{ "purpose": "dmarc", "name": "_dmarc.acme.com", "type": "TXT", "mode": "created" }], "adopted": 6, "conflicts": [], "failures": [], "steps": [], "retired": [], "leftovers": [], "probe": null, "error": null }, "dns": { "object": "domain_dns", "domain": "acme.com", "managing": true, "state": "ready", "…": "…" }, "zone": { "kind": "resolved", "cached": false, "…": "…" }}Antwortet keine einzelne Zone, wird nichts geschrieben: outcome ist refused, message sagt, warum, und zone listet die Zonen auf, aus denen Sie wählen können.
Läuft auf der Domain bereits eine Synchronisierung, ergibt das 409 dns_busy, und ein Anbieter, der die Anfrage ablehnt, ergibt 502 dns_provider_error. Eine Domain, die auf ihre Einträge wartet, wird verifiziert, sobald sie vorhanden sind.
Ein OAuth-Zugriffstoken braucht für diesen Aufruf einen Bestätigungscode. Solange die App in den letzten 60 Minuten keinen bestätigt hat, antwortet der Aufruf mit 403 step_up_required und ändert nichts. Ein API-Schlüssel wird nie gefragt. Die Seite Authentifizierung zeigt, wie Sie einen Code anfordern und bestätigen.