API REFERENCE

DNS-записи

GET/api/v1/domains/{id}/dns

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

Запрос

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

cURL

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

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

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

Bearer YOUR_API_KEY

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

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

Ответ

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

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

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

backendstring

delegationstring

snapshotobject

const: true

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

items[].idinteger

items[].record_typestring

Тип DNS-записи: например A, AAAA, CNAME, TXT, MX или SRV.

items[].namestring

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

items[].contentstring

Значение записи, соответствующее её типу.

items[].priorityinteger | null

Приоритет MX: меньшее значение предпочтительнее.

items[].ttlinteger

Время кэширования DNS в секундах; 1 — автоматическое.

items[].proxiedboolean

Проксировать совместимую запись через Cloudflare.

items[].commentstring

Служебная заметка к записи; не публикуется в DNS.

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

rrsets[].namestring

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

rrsets[].record_typestring

Тип DNS-записи: например A, AAAA, CNAME, TXT, MX или SRV.

rrsets[].expectedstring

Подпись текущего RRset из GET DNS. Защищает от перезаписи чужих изменений.

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

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

JSON

{
  "request_id": "00000000-0000-4000-8000-000000000001",
  "backend": "string",
  "delegation": "string",
  "snapshot": true,
  "items": [
    {
      "id": 1,
      "record_type": "string",
      "name": "example.com",
      "content": "string",
      "priority": 1,
      "ttl": 1,
      "proxied": false,
      "comment": "string"
    }
  ],
  "rrsets": [
    {
      "name": "example.com",
      "record_type": "string",
      "expected": "string"
    }
  ],
  "empty_rrset_expected": "string"
}

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

error.code · error.message · request_id

401

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

404

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

409

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

422

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

500

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

503

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