Saltar para a documentação
API

Listar domínios

Todos os domínios do workspace, com o respetivo estado de receção, envio, rastreio e ficheiros.

GETapi.openemail.uk/domains

Executa a chamada real contra o seu espaço de trabalho, com a sua própria chave.

GET /domains

Todos os domínios do workspace, com o respetivo estado de receção, envio, rastreio e ficheiros.

A receção e o envio são separados

Todos os domínios reportam a receção e o envio como dois objetos de estado independentes. receiving.verified significa que o MX do domínio traz o correio dele para aqui e que o desafio de propriedade está publicado, ou seja, o domínio pode receber entregas. Não diz nada sobre o tráfego de saída.

sending é a metade de saída, lida a partir da verificação de assinatura guardada do domínio e não de uma nova. sending.status é um de verified, pending, failed, no_identity ou unknown, sending.canSend diz se um envio a partir do domínio seria aceite neste momento, sending.checkedAt data esse veredito, sending.error traz a última falha e sending.note é uma frase que explica o estado. Um veredito negativo com mais de um dia é tratado como desconhecido e não como recusa, pelo que canSend pode ser true enquanto status está em pending.

tracking é um terceiro objeto, sobre o domínio de rastreio personalizado opcional do domínio e não sobre o correio dele. tracking.status é none enquanto não for definido nenhum, na aplicação ou com PATCH /domains/{id}, cuja página descreve todos os campos.

storage é um quarto objeto com os mesmos campos, sobre o domínio de ficheiros personalizado opcional do domínio: o nome usado pelas ligações de transferência dos ficheiros enviados a partir do domínio. É definido da mesma forma e na mesma página, e storage.status é none enquanto não for definido nenhum.

Exemplo

Requer domains:read.

curl
curl "$OE/domains" -H "$AUTH"
Resposta
{  "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 a null significa que o DNS nunca foi consultado: «ainda não olhámos», e não «falhou». As duas coisas leem-se de forma muito diferente trinta segundos depois de adicionar um domínio.