API

Recuperar un domini

Afegeix les adreces que hi existeixen i si cadascuna està activada.

GETapi.openemail.uk/domains/{id}

Executa la crida real contra el teu espai de treball, amb la teva pròpia clau.

GET /domains/{id}

Afegeix les adreces que hi existeixen i si cadascuna està activada.

Exemple

Requereix domains:read.

curl

curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f" -H "$AUTH"

Resposta

{  "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"}

Una adreça desactivada deixa de ser lliurable. El correu que hi va es rebutja en temps d'SMTP, de manera que qui l'envia rep un rebot i no silenci.

Què encara no pots fer aquí

Encara no disponible

Les escriptures que accepta aquest recurs són el domini de seguiment personalitzat i el domini de fitxers personalitzat, totes dues mitjançant PATCH /domains/{id}. La resta de la configuració d'un domini, de moment, només es fa des de l'aplicació.

Afegir un domini i llegir els registres DNS que cal publicar. GET informa que un domini no està verificat però no de quin registre falta.
Forçar una nova comprovació de receiving o sending. Cap de les dues té endpoint, i cap no en necessita: un escombrat horari torna a comprovar tots els dominis no verificats pel seu compte, de manera que publicar els registres i deixar-los és tota la feina. Subscriu-te a domain.verified i domain.sending_changed en comptes de consultar GET /domains repetidament, i se't dirà l'instant en què qualsevol dels dos es mogui. PATCH /domains/{id} només comprova el domini de seguiment i el domini de fitxers.
Crear, desactivar o encaminar una adreça. COMPARTIR-NE una sí que està feta, ja que POST /members/{userId}/addresses lliura una adreça existent a algú a nivell member o viewer. El que aquest recurs no pot fer és fer existir l'adreça.

Tot això existeix a l'aplicació a Configuració → Dominis. El que falta és la superfície d'API, no la capacitat.