API

Uzskaitīt domēnus

Katrs darbvietas domēns ar tā saņemšanas, sūtīšanas, izsekošanas un failu stāvokli.

GETapi.openemail.uk/domains

Izpilda īstu izsaukumu pret jūsu darbvietu, ar jūsu paša atslēgu.

GET /domains

Katrs darbvietas domēns ar tā saņemšanas, sūtīšanas, izsekošanas un failu stāvokli.

Saņemšana un sūtīšana ir nošķirtas

Katrs domēns ziņo par saņemšanu un sūtīšanu kā par diviem neatkarīgiem stāvokļa objektiem. receiving.verified nozīmē, ka domēna MX atved tā pastu šurp un ir publicēts tā īpašumtiesību izaicinājums, tātad domēns var pieņemt piegādi. Par izejošo pastu tas nesaka neko.

sending ir izejošā puse, nolasīta no domēna uzglabātās parakstīšanas pārbaudes, nevis no svaigas. sending.status ir viens no verified, pending, failed, no_identity vai unknown, sending.canSend pasaka, vai sūtījums no domēna tiktu pieņemts tieši tagad, sending.checkedAt datē šo spriedumu, sending.error nes pēdējo kļūdu, un sending.note ir teikums, kas stāvokli izskaidro. Negatīvs spriedums, kas vecāks par dienu, tiek uzskatīts par nezināmu, nevis par atteikumu, tāpēc canSend var būt true, kamēr status ir pending.

tracking ir trešais objekts, un tas ir par domēna neobligāto pielāgoto izsekošanas domēnu, nevis par tā pastu. tracking.status ir none, līdz kāds ir iestatīts — lietotnē vai ar PATCH /domains/{id}, kura lapa apraksta katru lauku.

storage ir ceturtais objekts ar tiem pašiem laukiem, un tas ir par domēna neobligāto pielāgoto failu domēnu: nosaukumu, ko izmanto lejupielādes saites failiem, kas sūtīti no šī domēna. To iestata tāpat un tajā pašā lapā, un storage.status ir none, līdz kāds ir iestatīts.

Piemērs

Nepieciešams domains:read.

curl

curl "$OE/domains" -H "$AUTH"

Atbilde

{  "object": "list",  "data": [    {      "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      },      "createdAt": "2026-08-14T09:55:11.000Z"    }  ]}

lastCheckedAt ar null nozīmē, ka DNS nekad nav aplūkots: “mēs vēl neesam skatījušies”, nevis “tas neizdevās”. Trīsdesmit sekundes pēc domēna pievienošanas šie divi lasās ļoti atšķirīgi.