API REFERENCE

Состояние домена

GET/api/v1/domains/{id}

Работает только с данными вашего аккаунта. Передавайте API-ключ в заголовке Authorization. Ответы возвращаются в JSON.

Запрос

В BASE_URL укажите HTTPS-адрес этого сайта, в API_KEY — свой секретный ключ. RESOURCE_ID замените идентификатором из ответа API.

cURL

curl --request GET "${BASE_URL}/api/v1/domains/RESOURCE_ID" \
  --header "Authorization: Bearer $API_KEY"

Заголовки и параметры

Authorizationобязательно

Bearer YOUR_API_KEY

idpath · stringобязательно

Числовой ID домена; UUID для заказа, операции или запроса.

Ответ

202 означает «принято», а не «выполнено». Проверяйте состояние заказа или операции. При неизвестном результате не создавайте повторную покупку. Суммы — десятичные строки в USD, даты — ISO 8601.

request_idstringобязательно

Идентификатор для восстановления результата после сетевого сбоя.

idintegerобязательно

namestringобязательно

@ — корень, * — wildcard, либо имя записи.

categorystring

Категория цены: basic или protected.

expires_atstring | null

autorenewboolean

archivedboolean

nameserversarray

Имена серверов DNS, не IP-адреса.

dns_backendstring

delegationstring

renewal_periodsarray

cloudflareobjectобязательно

cloudflare.connectedboolean

cloudflare.statusstring

Текущее состояние. Принятое задание ещё не означает успех.

cloudflare.ssl_statusstring

Состояние сертификата Cloudflare для посетителей.

cloudflare.origin_tls_statusstring

Отдельное состояние HTTPS между Cloudflare и сервером.

cloudflare.nameserversarray

Имена серверов DNS, не IP-адреса.

cloudflare.checked_atstring | null

cloudflare.settingsobject

cloudflare.geo_countriesarray

cloudflare.available_settingsobject

Пример структуры ответа · условные значения

JSON

{
  "request_id": "00000000-0000-4000-8000-000000000001",
  "id": 1,
  "name": "example.com",
  "category": "string",
  "expires_at": "2026-10-02T12:00:00Z",
  "autorenew": false,
  "archived": false,
  "nameservers": [
    "string"
  ],
  "dns_backend": "string",
  "delegation": "string",
  "renewal_periods": [
    1
  ],
  "cloudflare": {
    "connected": false,
    "status": "string",
    "ssl_status": "string",
    "origin_tls_status": "string",
    "nameservers": [
      "string"
    ],
    "checked_at": "2026-10-02T12:00:00Z",
    "settings": {},
    "geo_countries": [
      "string"
    ],
    "available_settings": {}
  }
}

Ошибки и статусы

error.code · error.message · request_id

401

Ключ неверен или отозван.

404

Ресурс не найден в вашем аккаунте.

409

Конфликт ключа повтора или запрос ещё выполняется.

422

Неверные параметры или условия операции, включая баланс.

500

Результат может быть неизвестен. Проверьте запрос.

503

Временно недоступно. Учитывайте Retry-After.