Ga direct naar de documentatie
API

Domeinen opvragen

Elk domein op de workspace, met zijn status voor ontvangen, verzenden, tracking en bestanden.

GETapi.openemail.uk/domains

Voert de echte aanroep uit op je workspace, met je eigen sleutel.

GET /domains

Elk domein op de workspace, met zijn status voor ontvangen, verzenden, tracking en bestanden.

Ontvangen en verzenden staan los van elkaar

Elk domein rapporteert ontvangen en verzenden als twee onafhankelijke statusobjecten. receiving.verified betekent dat de MX van het domein zijn post hierheen brengt en dat de eigendomscontrole is gepubliceerd, zodat het domein bezorging kan aannemen. Het zegt niets over uitgaand verkeer.

sending is de uitgaande helft, gelezen uit de opgeslagen ondertekeningscontrole van het domein in plaats van uit een verse. sending.status is een van verified, pending, failed, no_identity of unknown, sending.canSend zegt of een verzending vanaf het domein op dit moment zou worden geaccepteerd, sending.checkedAt dateert dat oordeel, sending.error bevat de laatste fout en sending.note is een zin die de toestand uitlegt. Een negatief oordeel van ouder dan een dag wordt als onbekend behandeld in plaats van als weigering, dus canSend kan true zijn terwijl status pending is.

tracking is een derde object, over het optionele eigen tracking-domein van het domein in plaats van over zijn post. tracking.status is none totdat er een is ingesteld, in de app of met PATCH /domains/{id}, waarvan de pagina elk veld beschrijft.

storage is een vierde object met dezelfde velden, over het optionele eigen bestandsdomein van het domein: de naam die de downloadlinks gebruiken voor bestanden die vanaf het domein zijn verstuurd. Het wordt op dezelfde manier en op dezelfde pagina ingesteld, en storage.status is none totdat er een is ingesteld.

Voorbeeld

Vereist domains:read.

curl
curl "$OE/domains" -H "$AUTH"
Antwoord
{  "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 null betekent dat er nooit naar DNS is gekeken: "we hebben nog niet gekeken", niet "het is mislukt". Die twee lezen heel verschillend, dertig seconden nadat je een domein hebt toegevoegd.