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

Получение адреса веб-приложения

Адрес веб-приложения рабочего пространства, можно ли там входить, и запись CNAME, которая ему нужна. Если адрес не задан, `status` равен `none`, а `domains` перечисляет домены, под которыми его можно разместить.

GET/app-host

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

GET /app-host

Адрес веб-приложения рабочего пространства, можно ли там входить, и запись CNAME, которая ему нужна. Если адрес не задан, status равен none, а domains перечисляет домены, под которыми его можно разместить.

Что такое адрес веб-приложения

shell
export OE=https://api.openemail.ukexport AUTH="Authorization: Bearer $OPENEMAIL_API_KEY"

Рабочее пространство на платном тарифе может открывать веб-приложение на поддомене одного из своих подтверждённых доменов, например mailbox.acme.com, а также на openemail.uk. Это адрес, который задаёт вкладка «Приложение с вашим брендом» в настройках «Внешний вид» рабочего пространства, и у рабочего пространства таких адресов не больше одного.

Входить там могут только участники рабочего пространства, люди, которые входят с одним из его адресов, и все, у кого есть ожидающее приглашение, и только они получают оттуда письма для сброса пароля и подтверждения. Пока рабочее пространство не задаст логотип на странице «Внешний вид», адрес выглядит как openemail.uk, а потом показывает логотип, знак и название рабочего пространства вместо наших. С этого момента письма, которые им отправляет OpenEmail, несут бренд, ведут обратно на этот адрес и приходят с noreply@ его домена, как только записи подписи этого домена подтверждены.

Ему нужна одна запись CNAME, которую подробно описывает record. Адрес находится в состоянии pending, пока запись не начнёт отвечать и не будет выпущен его сертификат, а после этого переходит в active. На бесплатном тарифе он сохраняется, но приостанавливается: paused равен true, и никто не может там войти, пока рабочее пространство снова не перейдёт на платный тариф.

Пример

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

curl
curl "$OE/app-host" -H "$AUTH"
Ответ
{  "object": "app_host",  "id": "ahost_3f9c2a71d0b84e56a1c7f2e9",  "host": "mailbox.acme.com",  "domainId": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f",  "domain": "acme.com",  "status": "active",  "active": true,  "paused": false,  "target": "cname.openemail.uk",  "record": {    "type": "CNAME",    "name": "mailbox.acme.com",    "value": "cname.openemail.uk"  },  "error": null,  "checkedAt": "2026-10-01T09:12:30.000Z",  "verifiedAt": "2026-10-01T09:04:11.000Z",  "available": true,  "paidPlan": true,  "domains": ["acme.com"],  "suggested": "mailbox.acme.com"}

Чтение снова проверяет адрес, если последней проверке больше 15 секунд, поэтому, чтобы дождаться, когда active станет true, опрашивайте этот маршрут.

active равен true, только когда status равен active и рабочее пространство на платном тарифе. paused равен true, когда адрес задан, а рабочее пространство на бесплатном тарифе.

Ваши входящие,
на ваших условиях.

Почтовая инфраструктура для бизнеса, ИИ, агентов и личной почты. Создана для масштаба, приватности и контроля. Всё, что должно было быть в почте с первого дня.