दस्तावेज़ पर जाएँ
API

डोमेन प्राप्त करें

इसमें वे पते भी जुड़ते हैं जो उस पर मौजूद हैं और यह भी कि हर एक enabled है या नहीं।

GETapi.openemail.uk/domains/{id}

असली कॉल आपकी अपनी कुंजी से आपके वर्कस्पेस पर चलाता है।

GET /domains/{id}

इसमें वे पते भी जुड़ते हैं जो उस पर मौजूद हैं और यह भी कि हर एक enabled है या नहीं।

उदाहरण

domains:read चाहिए।

curl
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f" -H "$AUTH"
प्रतिक्रिया
{  "object": "domain",  "id": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f",  "domain": "acme.com",  "receiving": {    "verified": true,    "verifiedAt": "2026-08-14T10:02:00.000Z",    "catchAll": false,    "lastCheckedAt": "2026-08-29T06:00:00.000Z",    "error": null  },  "sending": {    "status": "verified",    "canSend": true,    "checkedAt": "2026-08-29T06:00:00.000Z",    "error": null,    "note": "Mail from this domain is signed and can be sent."  },  "tracking": {    "host": "links.acme.com",    "status": "active",    "active": true,    "target": "oelinks3f9a1c7e2b8d4a60.edge.openemail.uk",    "record": { "type": "CNAME", "name": "links.acme.com", "value": "oelinks3f9a1c7e2b8d4a60.edge.openemail.uk" },    "checkedAt": "2026-08-29T06:10:00.000Z",    "verifiedAt": "2026-08-29T06:10:00.000Z",    "error": null  },  "storage": {    "host": "files.acme.com",    "status": "active",    "active": true,    "target": "oefiles81c40d6b2f7e9a35.edge.openemail.uk",    "record": { "type": "CNAME", "name": "files.acme.com", "value": "oefiles81c40d6b2f7e9a35.edge.openemail.uk" },    "checkedAt": "2026-08-29T06:10:00.000Z",    "verifiedAt": "2026-08-29T06:10:00.000Z",    "error": null  },  "addresses": [    { "address": "[email protected]", "enabled": true },    { "address": "[email protected]", "enabled": false }  ],  "createdAt": "2026-08-14T09:55:11.000Z"}

बंद किया गया पता डिलीवरी योग्य नहीं रहता। उस पर आया मेल SMTP के समय ही अस्वीकार हो जाता है, इसलिए भेजने वाले को चुप्पी के बजाय bounce मिलता है।

यहाँ अभी आप क्या नहीं कर सकते

अभी जारी नहीं हुआ

यह संसाधन जो लेखन स्वीकार करता है वे हैं कस्टम tracking डोमेन और कस्टम files डोमेन, दोनों PATCH /domains/{id} के ज़रिए। डोमेन की बाकी सेटअप फ़िलहाल केवल ऐप में है।

  • डोमेन जोड़ना, और प्रकाशित करने के लिए DNS रिकॉर्ड पढ़ना। GET बताता है कि डोमेन असत्यापित है, पर यह नहीं कि कौन-सा रिकॉर्ड गायब है।
  • receiving या sending की दोबारा जाँच शुरू करना। किसी के लिए एंडपॉइंट नहीं है, और किसी को ज़रूरत भी नहीं: हर घंटे चलने वाला sweep हर असत्यापित डोमेन की ख़ुद दोबारा जाँच करता है, इसलिए रिकॉर्ड प्रकाशित करके छोड़ देना ही पूरा काम है। GET /domains को बार-बार पोल करने के बजाय domain.verified और domain.sending_changed की सदस्यता लें, और जैसे ही इनमें से कुछ बदलेगा आपको बता दिया जाएगा। PATCH /domains/{id} केवल tracking डोमेन और files डोमेन जाँचता है।
  • पता बनाना, बंद करना या उसकी राउटिंग करना। साझा करना बना हुआ है, क्योंकि POST /members/{userId}/addresses किसी मौजूदा पते को member या viewer स्तर पर किसी को सौंप देता है। जो यह संसाधन नहीं कर सकता वह है पते को अस्तित्व में लाना।

यह सब ऐप में Settings → Domains के नीचे मौजूद है। जो गायब है वह API सतह है, क्षमता नहीं।