Для AI-агентов: markdown этой страницы — /docs-content/infra/domain/get.md индекс документации — /llms.txt

Получить домен

GET /v1/infra/servers/:id/domain

Возвращает домен, привязанный к серверу. Вызов подходит и для повторного чтения DNS-записей, и для ожидания сертификата после проверки.

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

Параметры

Параметр В Тип Обяз. Описание
Параметрid Вpath Типstring (UUID) Обяз.да ОписаниеID сервера. Источник — поле id из списка серверов

Примеры

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

Terminal 
curl -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.tech/v1/infra/servers/SERVER_ID/domain

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

Terminal 
curl -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.tech/v1/infra/servers/SERVER_ID/domain

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

javascript 
const res = await fetch(
  `https://vibecode.bitrix24.tech/v1/infra/servers/${serverId}/domain`,
  { headers: { 'X-Api-Key': 'YOUR_API_KEY' } }
)
const body = await res.json()
if (res.status === 404 && body.error.code === 'NO_DOMAIN') {
  console.log('К серверу домен не привязан')
} else {
  const { domain } = body.data
  console.log(`${domain.fqdn}: ${domain.status}, сертификат: ${domain.certIssued}`)
}

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

javascript 
const res = await fetch(
  `https://vibecode.bitrix24.tech/v1/infra/servers/${serverId}/domain`,
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata.domain.id Типstring (UUID) ОписаниеID привязки домена
Полеdata.domain.fqdn Типstring ОписаниеПривязанное имя в нижнем регистре
Полеdata.domain.isApex Типboolean Описаниеtrue — корневой домен зоны, false — поддомен
Полеdata.domain.status Типstring ОписаниеСтатус домена. Значения — Статусы домена
Полеdata.domain.source Типstring ОписаниеПроисхождение домена. "BYO" — домен ваш и подключён вами
Полеdata.domain.dnsMode Типstring ОписаниеКто ведёт DNS-записи. "USER_DNS" — вы, у своего DNS-провайдера
Полеdata.domain.verifiedAt Типstring (ISO 8601) | null ОписаниеМомент успешной проверки, после которой домен стал ACTIVE. null, пока успешной проверки не было
Полеdata.domain.lastVerifiedAt Типstring (ISO 8601) | null ОписаниеМомент последней проверки записей, включая неуспешную. null, пока проверка не запускалась
Полеdata.domain.createdAt Типstring (ISO 8601) ОписаниеМомент привязки
Полеdata.domain.certIssued Типboolean ОписаниеВыпущен ли сертификат для https. Вне статуса ACTIVE всегда false
Полеdata.instructions Типarray ОписаниеDNS-записи домена — те же, что вернула привязка. Пустой массив, если регион аккаунта Битрикс24 перестал поддерживать свои домены
Полеdata.instructions[].type Типstring ОписаниеТип записи: "TXT", "CNAME" или "A"
Полеdata.instructions[].host Типstring ОписаниеПолное имя записи
Полеdata.instructions[].zone Типstring ОписаниеЗона, в которой создаётся запись
Полеdata.instructions[].name Типstring ОписаниеИмя записи относительно zone — его вводят в поле «имя» панели DNS-провайдера. Для самой зоны — "@"
Полеdata.instructions[].value Типstring ОписаниеЗначение записи

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

Домен прошёл проверку, сертификат ещё не выпущен:

JSON 
{
  "success": true,
  "data": {
    "domain": {
      "id": "bea9db66-411b-432e-a365-283a74f5714f",
      "fqdn": "app.example.com",
      "isApex": false,
      "status": "ACTIVE",
      "source": "BYO",
      "dnsMode": "USER_DNS",
      "verifiedAt": "2026-10-05T12:53:02.655Z",
      "lastVerifiedAt": "2026-10-05T12:53:02.653Z",
      "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"
      }
    ]
  }
}

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

404 — сервер найден, но домен к нему не привязан:

JSON 
{
  "success": false,
  "error": {
    "code": "NO_DOMAIN",
    "message": "No domain attached"
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодNO_DOMAIN ОписаниеСервером управляет ключ вызова, но домен к серверу не привязан
HTTP404 КодSERVER_NOT_FOUND ОписаниеСервера с таким id нет, либо им управляет не тот ключ, которым сделан вызов
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодINVALID_API_KEY ОписаниеКлюч не опознан: такой строки на платформе нет
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит 60 запросов в минуту на этот эндпоинт. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики)
HTTP503 Кодuser_self_deletion_pending ОписаниеВладелец ключа запросил удаление своего аккаунта на портале. Доступ вернётся после отмены удаления

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

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

  • Чтение само проверяет сертификат. Пока домен в статусе ACTIVE, а certIssued равен false, каждый вызов открывает пробное TLS-соединение по имени домена и из-за этого отвечает до 4 секунд дольше. Как только сертификат найден, certIssued становится true, и следующие чтения проходят без этой задержки.
  • Сертификат ожидается заново после восстановления. Домен, вернувшийся в ACTIVE повторной проверкой из статуса FAILED или SUSPENDED, получает certIssued: true не сразу: прежний признак сброшен, и чтение ждёт сертификат ещё раз.
  • Записи нужны и после активации. Платформа периодически перепроверяет обе записи у активного домена, поэтому удалять их у DNS-провайдера после перехода в ACTIVE нельзя.

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