Lidhjet DNS
Llogaritë e ofruesve të DNS-së të lidhura me hapësirën e punës, përmes të cilave OpenEmail i shkruan vetë regjistrimet e një domeni. Një llogari lidhet në aplikacion, sepse ofruesi i kërkon personit të hyjë.
Ekzekuton cilëndo nga 3 thirrjet në hapësirën tuaj të punës.
GET /dns-connections
Llogaritë e ofruesve të DNS-së të lidhura me hapësirën e punës, përmes të cilave OpenEmail i shkruan vetë regjistrimet e një domeni. Një llogari lidhet në aplikacion, sepse ofruesi i kërkon personit të hyjë.
Listoni lidhjet
Kërkon domains:read. Çdo lidhje, përfshirë ato të shkëputura, me domenet që shërben secila. configured është false kur ky server nuk mund të lidhë fare një ofrues.
curl "$OE/dns-connections" -H "$AUTH"{ "object": "list", "configured": true, "data": [ { "object": "dns_connection", "id": "dnsl_3f9a1c2e7b4d4e6f8a0b2c3d", "provider": "cloudflare", "subject": "[email protected]", "accounts": [{ "id": "4f1c2b3a5d6e7f8091a2b3c4d5e6f708", "name": "Acme" }], "status": "active", "lastVerifiedAt": "2026-09-30T08:00:00.000Z", "lastError": null, "createdAt": "2026-09-01T10:12:00.000Z", "domains": [ { "domainId": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f", "domain": "acme.com", "zoneId": "023e105f4ecef8ad9ca31a8372d0c353", "zoneName": "acme.com", "state": "ready", "records": 7, "keepsMail": true, "busy": false } ], "records": 7, "removable": false } ]}status është active ndërsa OpenEmail mund të shkruajë përmes lidhjes, needs-reauth kur ofruesi do që llogaria të lidhet sërish në aplikacion, revoked pasi të jetë shkëputur dhe error kur thirrja e fundit dështoi.
Lexoni një lidhje
Kërkon domains:read. GET /dns-connections/{id} shton pasojat e shkëputjes së saj: busy emërton domenet ku po ekzekutohet një sinkronizim, dhe keepsMail domenet e verifikuara që pushojnë së marri postë sapo të tërhiqen regjistrimet e tyre.
curl "$OE/dns-connections/dnsl_3f9a1c2e7b4d4e6f8a0b2c3d" -H "$AUTH"{ "object": "dns_connection", "id": "dnsl_3f9a1c2e7b4d4e6f8a0b2c3d", "provider": "cloudflare", "subject": "[email protected]", "accounts": [{ "id": "4f1c2b3a5d6e7f8091a2b3c4d5e6f708", "name": "Acme" }], "status": "active", "lastVerifiedAt": "2026-09-30T08:00:00.000Z", "lastError": null, "createdAt": "2026-09-01T10:12:00.000Z", "domains": [ { "domainId": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f", "domain": "acme.com", "zoneId": "023e105f4ecef8ad9ca31a8372d0c353", "zoneName": "acme.com", "state": "ready", "records": 7, "keepsMail": true, "busy": false } ], "records": 7, "removable": false, "busy": [], "keepsMail": ["acme.com"]}Shkëputni një lidhje
Kërkon domains:write. DELETE /dns-connections/{id} tërheq regjistrimet e shkruara përmes lidhjes, shkëput çdo domen që ajo shërben dhe e revokon te ofruesi. Një domen i verifikuar, regjistrimet e të cilit tërhiqen, pushon së marri postë, ndaj lexojeni fillimisht lidhjen.
curl -X DELETE "$OE/dns-connections/dnsl_3f9a1c2e7b4d4e6f8a0b2c3d" -H "$AUTH"{ "object": "dns_connection", "id": "dnsl_3f9a1c2e7b4d4e6f8a0b2c3d", "provider": "cloudflare", "subject": "[email protected]", "accounts": [{ "id": "4f1c2b3a5d6e7f8091a2b3c4d5e6f708", "name": "Acme" }], "status": "revoked", "lastVerifiedAt": "2026-09-30T08:00:00.000Z", "lastError": null, "createdAt": "2026-09-01T10:12:00.000Z", "removed": false, "confirmed": true, "detached": { "domains": 1, "detached": 1, "removed": 7, "rewritten": 0, "pending": 0, "left": [] }}Fshirja e një lidhjeje që është shkëputur tashmë e heq atë nga lista, sapo të mos ketë mbetur asnjë domen dhe asnjë regjistrim në të, dhe removed është true. Kur ka ende diçka në të, thirrja është 409 dns_connection_in_use.
Kur po ekzekutohet një sinkronizim në një nga domenet e saj, kërkesa refuzohet me 409 dns_busy dhe asgjë nuk revokohet.
Një çelës ose një aplikacion i kufizuar në adresa ose domene të caktuara refuzohet me 422 capability_unsupported, dhe një aplikacion që vepron për një anëtar ka nevojë edhe për workspace:manage në rolin e tij.
Një token qasjeje OAuth ka nevojë për një kod verifikimi për këtë thirrje. Derisa aplikacioni të ketë verifikuar një në 60 minutat e fundit, thirrja përgjigjet me 403 step_up_required dhe nuk ndryshon asgjë. Një çelësi API nuk i kërkohet kurrë. Faqja Autentikimi tregon si të kërkoni një kod dhe ta verifikoni.