Перейти к документации
API

Список доменов

Все домены рабочего пространства с их состоянием приёма, отправки, трекинга и файлов.

GETapi.openemail.uk/domains

Выполняет настоящий запрос в вашем рабочем пространстве, с вашим собственным ключом.

GET /domains

Все домены рабочего пространства с их состоянием приёма, отправки, трекинга и файлов.

Приём и отправка разделены

Каждый домен сообщает о приёме и отправке двумя независимыми объектами состояния. receiving.verified означает, что MX домена приводит его почту сюда и что подтверждение владения опубликовано, то есть домен может принимать доставку. Об исходящей почте это не говорит ничего.

sending — исходящая половина, читаемая из сохранённой проверки подписи домена, а не из свежей. sending.status принимает одно из значений verified, pending, failed, no_identity или unknown, sending.canSend говорит, была бы отправка с домена принята прямо сейчас, sending.checkedAt датирует этот вердикт, sending.error несёт последнюю ошибку, а sending.note — фраза, объясняющая состояние. Отрицательный вердикт старше суток считается неизвестным, а не отказом, поэтому canSend может быть true, пока status равен pending.

tracking — третий объект, посвящённый необязательному собственному tracking-домену, а не почте. tracking.status равен none, пока такой домен не задан — в приложении или через PATCH /domains/{id}, на странице которого описано каждое поле.

storage — четвёртый объект с теми же полями, посвящённый необязательному собственному домену для файлов: имени, которое используют ссылки на скачивание файлов, отправленных с этого домена. Задаётся он так же и на той же странице, а storage.status равен none, пока не задан.

Пример

Требуется domains:read.

curl
curl "$OE/domains" -H "$AUTH"
Ответ
{  "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, означает, что в DNS ещё ни разу не смотрели: «мы пока не смотрели», а не «не получилось». Через тридцать секунд после добавления домена это читается совершенно по-разному.