DNS басқару API

Шолу

DNS API DNS аймақтарды және жазбаларды толық басқаруға мүмкіндік береді. Барлық аймақтарды VPS.org- дің рұқсат етілген атау серверлері автоматты түрде BIND9 аймақ файлдарын құрып, орналастырады.

Атау серверінің құрылымы

• ns1.vps.org (38.248.6.195) - DNSSEC- дің ішкі қолтаңбасы бар негізгі бас сервер
• ns2.vps.org (38.248.6.196) - Екінші деңгейлі slave
• ns3.vps.org (38.248.6.197) - Екінші деңгейлі slave

Басты мүмкіндіктері

• Автоматты BIND9 аймақ файлын құру және орналастыру
• Аудан аутентификациясы арқылы ауысады (басшы- бағынышты репликациясы)
• Барлық негізгі DNS жазу түрлерін қолдау (A, AAAA, CNAME, MX, TXT, NS, SRV, CAA)
• Домен атауын сүзгілеу және UUID- негіздеген аймақ идентификациясы
• Аумақтарға тән жазбаларды басқару үшін ендірілген жолдар

Аутентификация

Барлық DNS API сұраныстары Bearer token аутентификациясын талап етеді. API token- дарын тіркелгіңіздің панелінен құрыңыз /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 жазуларын басқару (түсіндіру)

Бірнеше DNS жазуларына арналған толық CRUD операциялары, жазу 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- records / үшін)

Мысалы: жазудың 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- 1800 секунд (5- 30 минут) жылдам сынау үшін

Жалпы үлгілер

• Түбір домен (@): CNAME емес, A/ AAAA жазулар қолданылсын
• www субдомені: CNAME- дің тамырға немесе бөлек A жазуына сілтемесін қолдануға болады
• Эл. пошта (MX): Әрқашан артықшылығы қосылсын, төменгі сан = жоғары артықшылығы
• CNAME: Бір атау үшін басқа жазу түрлерімен бір уақытта болуы мүмкін емес

Қауіпсіздік

• CAA жазулары: Куәліктерді шығара алатын куәлік берушілерді келтіріңіз
• SPF/DKIM/DMARC: Эл. пошта аутентификациясын жалғандықтан қорғау үшін баптауName
• Қалыпты тексерулер: 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