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

Получение домена

Добавляет адреса, существующие на нём, и признак того, включён ли каждый из них.

GETapi.openemail.uk/domains/{id}

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

GET /domains/{id}

Добавляет адреса, существующие на нём, и признак того, включён ли каждый из них.

Пример

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

curl
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f" -H "$AUTH"
Ответ
{  "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"}

На выключенный адрес доставка прекращается. Письма на него отклоняются на этапе SMTP, поэтому отправитель получает возврат, а не молчание.

Чего здесь пока нельзя сделать

Ещё не выпущено

Этот ресурс принимает на запись собственный tracking-домен и собственный домен для файлов — оба через PATCH /domains/{id}. Остальная настройка домена пока доступна только в приложении.

  • Добавление домена и чтение DNS-записей, которые нужно опубликовать. GET сообщает, что домен не верифицирован, но не говорит, какой записи не хватает.
  • Запуск повторной проверки receiving или sending. Ни у того, ни у другого нет эндпоинта, и он им не нужен: ежечасный обход сам перепроверяет каждый неверифицированный домен, поэтому опубликовать записи и оставить их — вся работа. Подпишитесь на domain.verified и domain.sending_changed вместо опроса GET /domains, и вам сообщат в тот момент, когда что-то из них изменится. PATCH /domains/{id} проверяет только tracking-домен и домен для файлов.
  • Создание, отключение или маршрутизация адреса. ПРЕДОСТАВЛЕНИЕ доступа к адресу уже реализовано: POST /members/{userId}/addresses передаёт существующий адрес кому-то на уровне member или viewer. Этот ресурс не может именно создать адрес.

Всё это есть в приложении в разделе Settings → Domains. Не хватает именно поверхности API, а не возможности.