Przejdź do dokumentacji
API

Lista domen

Każda domena w przestrzeni roboczej wraz ze stanem odbioru, wysyłki, śledzenia i plików.

GETapi.openemail.uk/domains

Uruchamia prawdziwe wywołanie na twojej przestrzeni roboczej, twoim własnym kluczem.

GET /domains

Każda domena w przestrzeni roboczej wraz ze stanem odbioru, wysyłki, śledzenia i plików.

Odbiór i wysyłka są rozdzielone

Każda domena raportuje odbiór i wysyłkę jako dwa niezależne obiekty stanu. receiving.verified oznacza, że MX domeny kieruje jej pocztę tutaj, a jej wyzwanie potwierdzające własność jest opublikowane, więc domena może przyjmować doręczenia. Nie mówi nic o ruchu wychodzącym.

sending to połowa wychodząca, czytana z zapisanego sprawdzenia podpisywania domeny, a nie ze świeżego. sending.status przyjmuje jedną z wartości verified, pending, failed, no_identity lub unknown, sending.canSend mówi, czy wysyłka z domeny zostałaby teraz przyjęta, sending.checkedAt datuje ten werdykt, sending.error niesie ostatnią awarię, a sending.note to zdanie objaśniające stan. Negatywny werdykt starszy niż doba jest traktowany jako nieznany, a nie jako odmowa, więc canSend może być true, podczas gdy status to pending.

tracking to trzeci obiekt, dotyczący opcjonalnej własnej domeny śledzącej, a nie poczty. tracking.status ma wartość none, dopóki żadna nie zostanie ustawiona — w aplikacji albo przez PATCH /domains/{id}, na którego stronie opisano każde pole.

storage to czwarty obiekt o tych samych polach, dotyczący opcjonalnej własnej domeny plików: nazwy, której używają linki pobierania plików wysłanych z tej domeny. Ustawia się ją tak samo i na tej samej stronie, a storage.status ma wartość none, dopóki żadna nie zostanie ustawiona.

Przykład

Wymaga domains:read.

curl
curl "$OE/domains" -H "$AUTH"
Odpowiedź
{  "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 równe null oznacza, że DNS nigdy nie był sprawdzany: „jeszcze nie sprawdzaliśmy”, a nie „nie powiodło się”. Trzydzieści sekund po dodaniu domeny czyta się to zupełnie inaczej.