Свой домен

Собственный домен для приложения на сервере: приложение отвечает не только по адресу, выданному платформой, но и по имени, которым владеете вы. Привязка идёт в два шага — вы получаете DNS-записи, создаёте их у своего DNS-провайдера и запускаете проверку. Сертификат для https платформа выпускает сама после проверки.

Скоуп: vibe:infra

Привязать домен

POST /v1/infra/servers/:id/domain

Закрепляет ваше доменное имя за приложением на сервере и открывает первый шаг привязки — создание DNS-записей у DNS-провайдера домена. Запросы по домену приложение начинает принимать только после успешной проверки записей. У одного сервера один домен.

Кому доступен вызов — Доступ. Назначение записей и разница между именами host и name — DNS-записи.

Параметры

Поля запроса (body)

Примеры

curl — личный ключ

curl -X POST "https://vibecode.bitrix24.tech/v1/infra/servers/SERVER_ID/domain" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fqdn": "app.example.com"
  }'

curl — OAuth-приложение

curl -X POST "https://vibecode.bitrix24.tech/v1/infra/servers/SERVER_ID/domain" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fqdn": "app.example.com"
  }'

JavaScript — личный ключ

const res = await fetch(
  `https://vibecode.bitrix24.tech/v1/infra/servers/${serverId}/domain`,
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      fqdn: 'app.example.com',
    }),
  }
)
const { data } = await res.json()
for (const record of data.instructions) {
  console.log(`${record.type} ${record.name} → ${record.value}`)
}

JavaScript — OAuth-приложение

const res = await fetch(
  `https://vibecode.bitrix24.tech/v1/infra/servers/${serverId}/domain`,
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      fqdn: 'app.example.com',
    }),
  }
)

Поля ответа

Пример ответа

Ответ 201 на привязку поддомена:

{
  "success": true,
  "data": {
    "domain": {
      "id": "bea9db66-411b-432e-a365-283a74f5714f",
      "fqdn": "app.example.com",
      "isApex": false,
      "status": "PENDING_VERIFICATION",
      "source": "BYO",
      "dnsMode": "USER_DNS",
      "verifiedAt": null,
      "lastVerifiedAt": null,
      "createdAt": "2026-10-05T12:53:02.616Z",
      "certIssued": false
    },
    "instructions": [
      {
        "type": "TXT",
        "host": "_vibecode-challenge.app.example.com",
        "zone": "example.com",
        "name": "_vibecode-challenge.app",
        "value": "vibe-verify=f36ac31f213d1e3630c75f000b6631f5"
      },
      {
        "type": "CNAME",
        "host": "app.example.com",
        "zone": "example.com",
        "name": "app",
        "value": "lb.bitrix24site.ru"
      }
    ]
  }
}

Корневой домен example.com получил бы "isApex": true, а второй записью — "type": "A" с "name": "@" и IPv4-адресом в value. Остальная форма ответа не меняется.

Пример ответа при ошибке

409 — имя уже привязано к другому серверу платформы:

{
  "success": false,
  "error": {
    "code": "DOMAIN_TAKEN",
    "message": "This domain is already in use"
  }
}

Ошибки

Полный список общих ошибок API — Ошибки.

Известные особенности

• Порядок проверок. Скоуп ключа и принадлежность сервера проверяются первыми, затем три условия доступа к своим доменам, и только после них — тело запроса. Поэтому запрос с некорректным fqdn от аккаунта, которому свои домены недоступны, получит 403, а не 400. Исключение — INVALID_JSON_BODY: тело разбирается раньше проверки ключа, поэтому тело с синтаксической ошибкой JSON получает 400 до всех остальных отказов. Отказы FQDN_FORBIDDEN и DOMAIN_TAKEN_EXTERNAL приходят последними: их даёт реестр доменов, к которому платформа обращается после собственных проверок.
• Имя окончательно закрепляется при проверке. Привязка закрывает имя для других серверов платформы, но в реестре доменов Битрикс24 оно занимается только после успешной проверки. Если между привязкой и проверкой имя подключат к другому продукту Битрикс24, отказ DOMAIN_TAKEN_EXTERNAL вернёт уже проверка.
• Записи можно получить повторно. Массив instructions с тем же значением TXT в любой момент отдаёт GET /v1/infra/servers/:id/domain, сохранять ответ привязки не обязательно.

Смотрите также

• Получить домен
• Проверить домен
• Отвязать домен
• Свой домен
• Список серверов