DNS valdymo API

Apžvalga

DNS API užtikrina visišką DNS zonų ir įrašų valdymą. Visos zonos yra laikomos VPS.org autoritetingų pavadinimų serverių su automatiniu BIND9 zonos failų generavimu ir diegimu.

Vardų serverių infrastruktūra

• ns1.vps.org (38.248.6.195) - Pirminis kapitonas su DNSSEC parašu
• ns2.vps.org (38.248.6.196) - Antrinis vergas
• ns3.vps.org (38.248.6.197) - Antrinis vergas

Pagrindinės savybės

• Automatinis BIND9 zonos failų kūrimas ir diegimas
• Zona perdavimas pagal TSIG autentiškumo patvirtinimą (pavaldumo ir vergo replikacija)
• Parama visiems pagrindiniams DNS įrašų tipams (A, AAAA, CNAME, MX, TXT, NS, SRV, CAA)
• Sferos pavadinimo filtravimas ir UUID pagrįstos zonos identifikavimas
• Atogrąžų kirtimo maršrutai, skirti konkrečiai zonai tvarkyti

Autentifikavimas

Visi DNS API prašymai reikalauja Beaner žetonų autentiškumo patvirtinimo. Generuoti API žetonus iš savo paskyros prietaisų skydelio /account/developers/ su šiais leidimais:

• dns:list - Žiūrėti DNS zonas ir įrašus
• dns:create - Sukurti naujas zonas ir įrašus
• dns:update - Iš dalies pakeisti esamas zonas ir įrašus
• dns:delete - Išbraukti zonas ir įrašus
• dns:* - Visiška DNS valdymo prieiga

Pavyzdys

Authorization: Bearer vps_abc123def456...

Išvardinti visas DNS zonas

Gauti išspausdintą sąrašą visų DNS zonų, priklausančių patvirtintam vartotojui. Palaiko filtravimą pagal domeno vardą.

Užklausos parametrai

Prašymo pavyzdys

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);

Atsakymo pavyzdys

[
  {
    "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
  }
]

Atsakymo laukai

Atsakymo būsenos kodai

Gauti DNS zonos duomenis

Gaukite išsamią informaciją apie tam tikrą DNS zoną, įskaitant visus įrašus.

Kelio parametrai

Atsakymo pavyzdys

{
  "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"
    }
  ]
}

Atsakymo būsenos kodai

Sukurti DNS zoną

Sukurti naują DNS zoną domenui. Zona bus nedelsiant dislokuota VPS.org vardų serveriams.

Užklausos turinio parametrai

Prašymo pavyzdys

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);

Atsakymo pavyzdys

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

Atsakymo būsenos kodai

Ištrinti DNS zoną

Negrįžtamai ištrinti DNS zoną ir visus susijusius įrašus. Šis veiksmas negali būti atšauktas.

Kelio parametrai

Atsakymo būsenos kodai

DNS įrašų sąrašas zonoje

Gaukite visus DNS įrašus, skirtus konkrečiai zonai (numatytam maršrutui).

Kelio parametrai

Prašymo pavyzdys

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

Atsakymo pavyzdys

[
  {
    "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"
  }
]

Sukurti DNS įrašą zonoje

Pridėti naują DNS įrašą į konkrečią zoną (numatytas maršrutas).

Užklausos turinio parametrai

Prašymo pavyzdys

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())

Atsakymo būsenos kodai

Valdyti DNS įrašus (tiesioginė prieiga)

Visos CRUD operacijos atskiruose DNS įrašuose, naudojant įrašus UUID.

Galimos operacijos

• 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

Užklausos parametrai (dėl GET /api/v1/dns-records/)

Pavyzdys: Įrašo atnaujinimas 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

Geriausia patirtis

TTL konfigūracija

• Gamyba (stabilizuojama): 3600–86400 sekundžių (1–24 valandos)
• Prieš migraciją: 300-600 sekundžių (5-10 minučių) - Žemutinė TTL prieš planuojamus pakeitimus
• Vystymasis: 300–1800 sekundžių (5–30 minučių) greitesniam bandymui

Bendri modeliai

• Šakninis domenas (@): Naudoti A/AAAA įrašus, o ne CNAME
• www subdomain: Gali naudoti CNAME rodymą į šaknis arba atskirus įrašus
• El. paštas (MX): Visada įrašykite prioritetą, mažesnis skaičius = didesnis prioritetas
• CNAME: Negalima egzistuoti kartu su kitais to paties pavadinimo įrašų tipais

Saugumas

• CAA įrašai: Nurodyti, kurios valstybės narės gali išduoti sertifikatus
• SPF/DKIM/DMARC: Konfigūruoti elektroninio pašto autentiškumą siekiant išvengti spoofingo
• Reguliarus auditas: Peržiūrėti DNS įrašų ketvirtį, pašalinti nepanaudotus įrašus

Klaida tvarkant

Dažnos klaidos

Pavyzdinės klaidos atsakas

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

Testuoti DNS pakeitimus

Tikrinti įrašų platinimą

# 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

Naudoti internetinius įrankius

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