API керування DNS

Огляд

У API DNS передбачено повне керування зонами DNS і записами записів. Всі зони зберігаються на авторитетних серверах назв VPS.org з автоматичним створенням файлів BIND9 зон.

Інфраструктура сервера назв

• ns1.vps.org (38.248.6.195) - Основний майстер з вбудованим підписом DNSSEC
• ns2.vps.org (38.248.6.196) - Другорядний раб
• ns3.vps.org (38.248.6.197) - Другорядний раб

Можливості ключів

• Автоматичне створення і розповсюдження файлів зональної зони BIND9
• Перенесення зон за допомогою розпізнавання TSIG (головне відтворення підлеглого)
• Підтримка всіх основних типів записів DNS (A, AAAA, CNAME, MX, TXT, NS, SRV, CAA)
• Фільтрування назв доменів та ідентифікація зон UUID
• Розміщені маршрути для керування зональними записами

Автентифікація

Всі запити API DNS потребують автентифікації Bearer. Створити ключ API з панелі приладів керування обліковими записами на /account/developers/ з такими правами доступу:

• dns:list - Перегляд зон DNS і записів
• dns:create - Створити нові зони та записи
• dns:update - Змінити існуючі зони і записи
• dns:delete - Вилучити зони і записи
• dns:* - Повний доступ до керування DNS

Приклад

Authorization: Bearer vps_abc123def456...

Список усіх DNS-зон

Отримує застарілий список всіх зон DNS, які належать користувачеві, якого було розпізнано. Підтримує фільтрування за назвою домену.

Параметри запиту

Приклад запиту

curl -X GET "https://admin.vps.org/api/v1/dns-zones/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests

url = "https://admin.vps.org/api/v1/dns-zones/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/dns-zones/', {
  headers: {'Authorization': 'Bearer YOUR_API_TOKEN'}
});

const zones = await response.json();
console.log(zones);

Приклад відповіді

[
  {
    "uuid": "abc123-def456-ghi789",
    "domain": "example.com",
    "created_at": "2024-01-15T10:30:00Z",
    "record_count": 12
  },
  {
    "uuid": "xyz789-uvw456-rst123",
    "domain": "myapp.io",
    "created_at": "2024-06-20T14:15:00Z",
    "record_count": 8
  }
]

Поля відповідей

Коди стану відповіді

Отримати подробиці щодо поясу DNS

Отримати докладні відомості щодо певної зони DNS, разом з усіма записами.

Параметри шляху

Приклад відповіді

{
  "uuid": "abc123-def456-ghi789",
  "domain": "example.com",
  "created_at": "2024-01-15T10:30:00Z",
  "record_count": 5,
  "records": [
    {
      "uuid": "rec-001",
      "record_type": "A",
      "name": "@",
      "value": "192.0.2.1",
      "ttl": 3600,
      "priority": null,
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "uuid": "rec-002",
      "record_type": "MX",
      "name": "@",
      "value": "mail.example.com",
      "ttl": 3600,
      "priority": 10,
      "created_at": "2024-01-15T10:32:00Z"
    }
  ]
}

Коди стану відповіді

Створити зону DNS

Створити нову зону DNS для домену. Зону буде негайно прив' язано до VPS.org імен серверів.

Параметри тіла запиту

Приклад запиту

curl -X POST "https://admin.vps.org/api/v1/dns-zones/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "newdomain.com"}'

import requests

url = "https://admin.vps.org/api/v1/dns-zones/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {"domain": "newdomain.com"}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/dns-zones/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({domain: 'newdomain.com'})
});

const zone = await response.json();
console.log(zone);

Приклад відповіді

{
  "uuid": "new-zone-uuid",
  "domain": "newdomain.com",
  "created_at": "2026-01-18T16:45:00Z",
  "record_count": 0,
  "records": []
}

Коди стану відповіді

Вилучити зону DNS

Остаточно вилучити зону DNS і всі пов' язані з нею записи. Цю дію не можна скасувати.

Параметри шляху

Коди стану відповіді

Список записів DNS у зоні

Отримати всі записи DNS для певної зони (відсутнього маршруту).

Параметри шляху

Приклад запиту

curl -X GET "https://admin.vps.org/api/v1/dns-zones/{uuid}/records/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Приклад відповіді

[
  {
    "uuid": "rec-001",
    "record_type": "A",
    "name": "@",
    "value": "192.0.2.1",
    "ttl": 3600,
    "priority": null,
    "created_at": "2024-01-15T10:30:00Z"
  },
  {
    "uuid": "rec-002",
    "record_type": "MX",
    "name": "@",
    "value": "mail.example.com",
    "ttl": 3600,
    "priority": 10,
    "created_at": "2024-01-15T10:32:00Z"
  }
]

Створити запис DNS у зоні

Додати новий запис DNS до певної зони (відсутнього маршруту).

Параметри тіла запиту

Приклад запиту

curl -X POST "https://admin.vps.org/api/v1/dns-zones/{uuid}/records/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "record_type": "A",
    "name": "www",
    "value": "192.0.2.1",
    "ttl": 3600
  }'

import requests

url = f"https://admin.vps.org/api/v1/dns-zones/{zone_uuid}/records/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "record_type": "A",
    "name": "www",
    "value": "192.0.2.1",
    "ttl": 3600
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

Коди стану відповіді

Керування записами DNS (прямий доступ)

Повна операція CRUD з окремими записами DNS з використанням UUID запису.

Доступні дії

• GET /api/v1/dns-records/{uuid}/ - Retrieve record details
• PUT /api/v1/dns-records/{uuid}/ - Full update (all fields required)
• PATCH /api/v1/dns-records/{uuid}/ - Partial update (only changed fields)
• DELETE /api/v1/dns-records/{uuid}/ - Delete record

Параметри запиту (для GET / api/ v1/ dns- cords /)

Приклад: оновлення TTL запису

curl -X PATCH "https://admin.vps.org/api/v1/dns-records/{rec-uuid}/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ttl": 1800}'

Supported DNS Record Types

Найкращі вправи

Налаштування TTL

• Виробництво (стабільний): 3600- 86400 секунд (1- 24 години)
• Перед міграцією: 300- 600 секунд (5- 10 хвилин) - Нижня TTL перед запланованими змінами
• Розробка: 300- 800 секунд (5- 30 хвилин) для швидкого тестування

Загальні зразки

• Кореневий домен (@): Використовувати записи A/AAA, а не CNAME
• www subdomain: Може використовувати CNAME, що вказує на кореневу або окрему запис A
• Ел. пошта (MX): Завжди включати пріоритет, менше число = вищий пріоритет
• CNAME: Неможливо співіснувати з іншими типами записів для тієї ж назви

Безпека

• Записи CAA: Вкажіть, які сертифікати може видавати CA
• SPF/DKIM/DMARC: Налаштуйте автентифікацію ел. пошти, щоб запобігти перепочинанню
• Регулярні перевірки: Перегляд записів DNS щоквартально, вилучення невикористаних записів

Обробка помилок

Загальні помилки

Приклад відповіді на помилку

{
  "detail": "MX records require a priority value",
  "error_code": "validation_error",
  "field": "priority"
}

Перевірка змін DNS

Перевірити пропагацію запису

# Query A record
dig example.com A

# Query specific nameserver
dig @ns1.vps.org example.com

# Query MX records
dig example.com MX

# Check all records
dig example.com ANY

Користування мережевими інструментами

• whatsmydns.net: Check global DNS propagation
• dnschecker.org: Multi-location DNS lookup
• mxtoolbox.com: Email-related DNS testing