VPS.org API

REST API dokumentáció

DNS-kezelő API

Programozottan kezelheti domainjeinek DNS-zónáit és -rekordjait.

Végpontok 4 végpont
Alapút /api/v1/dns-zones
Hitelesítés Bearer Token szükséges

Áttekintés

A DNS API biztosítja a DNS zónák és rekordok teljes körű kezelését. Minden zóna VPS.org hiteles névszerveren található automatikus BIND9 zóna fájl generálással és telepítéssel.

Névszerver-infrastruktúra

Kulcsfontosságú jellemzők

Hitelesítés

Minden DNS API kérés szükséges Beaver token hitelesítés. Generate API tokens from your account dashboard at /account/developers/ a következő engedélyekkel:

Példa

Authorization: Bearer vps_abc123def456...
Fontos: API tokenek csak egyszer jelennek meg a teremtés során. Tárolja őket biztonságosan. Ha elveszít egy token, akkor létre kell hoznia egy újat.
KAP /api/v1/dns-zones/

Az összes DNS-zóna listázása

Szerezz egy paginált listát az összes DNS zóna tulajdonosa a hitelesített felhasználó. Támogatja szűrés domain név.

Lekérdezési paraméterek

Paraméter Típus Kívánt Leírás
domain string Nem. Filter zones by exact domain name (e.g., example.com)

Példa kérés

cURL
Python
JavaScript
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);

Példaválasz

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

Válaszmezők

Mező Típus Leírás
uuid string Unique zone identifier (used in API requests)
domain string Domain name for this DNS zone
created_at datetime Zone creation timestamp (ISO 8601 format)
record_count integer Total number of DNS records in this zone

Válasz állapotkódok

200 Successfully retrieved DNS zones list
401 Unauthorized - Invalid or missing API token
403 Forbidden - Token lacks dns:list permission
KAP /api/v1/dns-zones/{uuid}/

A DNS-zóna részletei

Részletes információk letöltése egy adott DNS zónáról, beleértve az összes rekordot is.

Útvonal paraméterei

Paraméter Típus Kívánt Leírás
uuid string Igen Unique zone identifier

Példaválasz

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

Válasz állapotkódok

200 Successfully retrieved zone details
404 Zone not found or not owned by user
HÓNAPPAL KÉSŐBB /api/v1/dns-zones/

DNS- zóna létrehozása

Hozzon létre egy új DNS zónát egy domain számára. A zónát azonnal bevetjük VPS.org névszerverre.

Kérés törzsének paraméterei

Paraméter Típus Kívánt Leírás
domain string Igen Domain name (e.g., example.com)

Példa kérés

cURL
Python
JavaScript
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);

Példaválasz

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

Válasz állapotkódok

201 DNS zone created successfully
400 Bad Request - Invalid domain name or zone already exists
403 Forbidden - Token lacks dns:create permission
TÖRÖL /api/v1/dns-zones/{uuid}/

A DNS- zóna törlése

Végleg törölje a DNS zónát és az összes kapcsolódó rekordot. Ezt a műveletet nem lehet visszavonni.

Útvonal paraméterei

Paraméter Típus Kívánt Leírás
uuid string Igen Unique zone identifier

Válasz állapotkódok

204 Zone deleted successfully (no response body)
403 Forbidden - Token lacks dns:delete permission
404 Zone not found
KAP /api/v1/dns-zones/{uuid}/records/

A DNS-rekordok listája a zónában

A DNS-adatok lekérdezése egy adott zónához (elszínezett útvonalhoz).

Útvonal paraméterei

Paraméter Típus Kívánt Leírás
uuid string Igen Zone UUID

Példa kérés

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

Példaválasz

[
  {
    "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"
  }
]
HÓNAPPAL KÉSŐBB /api/v1/dns-zones/{uuid}/records/

DNS rekord létrehozása a zónában

Új DNS-rekord hozzáadása egy adott zónához (nesztelt útvonal).

Kérés törzsének paraméterei

Paraméter Típus Kívánt Leírás
record_type string Igen Record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA
name string Igen Record name (@ for root, subdomain, or FQDN)
value string Igen Record value (IP address, hostname, text)
ttl integer No Time to live in seconds (default: 3600)
priority integer For MX/SRV Priority (required for MX and SRV records)

Példa kérés

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

Válasz állapotkódok

201 DNS record created successfully
400 Bad Request - Invalid parameters or validation error (e.g., MX record missing priority)
GET PUT PATCH DELETE /api/v1/dns-records/{uuid}/

DNS-rekordok kezelése (közvetlen hozzáférés)

Teljes CRUD művelet az egyes DNS-adatokon, UUID lemez használatával.

Rendelkezésre álló műveletek

Lekérdezési paraméterek (a GET /api/v1/dns-rekordok/)

Parameter Típus Leírás
zone string Filter records by zone UUID
record_type string Filter by record type (A, AAAA, MX, etc.)

Példa: Update TTL of a Record

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

Típus Purpose Example Value Priority Required
A Maps domain to IPv4 address 192.0.2.1 Nem.
AAAA Maps domain to IPv6 address 2001:0db8::1 Nem.
CNAME Creates alias to another domain example.com Nem.
MX Mail server for domain mail.example.com Igen
TXT Text record (SPF, DKIM, verification) v=spf1 include:_spf.google.com ~all Nem.
NS Nameserver delegation ns1.example.com Nem.
SRV Service location record 10 5060 sip.example.com Igen
CAA Certificate authority authorization 0 issue "letsencrypt.org" Nem.

Legjobb gyakorlatok

TTL- beállítások

Gyakori minták

Biztonság

Hibakezelés

Gyakori hibák

Állapotkód Hiba Oldat
400 Érvénytelen domain név A domain biztosítása a DNS névadó konvenciók szerint
400 Az MX rekord elsőbbséget igényel Beleértve a következőket: priority MX és SRV rekordok mezője
401 Érvénytelen API token Ellenőrizze a token formátumot (el kell kezdeni vps_)
403 Hiányzó engedély Új token generálása a szükségesel dns:* engedélyek
404 Övezet/rekord nem található Ellenőrizze az UUID-ot és győződjön meg róla, hogy az erőforrás a számlájához tartozik.

Példa Hibaelhárítás

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

A DNS-változások tesztelése

A Record Propagation ellenőrzése

# 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

Online eszközök használata