VPS.org API

REST API dokumentáció

Domains API

Keress domain neveket, regisztrálj és újítsd meg a domaineket, és kezeld a névszervereket és az automatikus megújulást. A domaineket az uuid azonosítják.

Végpontok 7
Alapút /api/v1/domains
KAP /api/v1/domains/

Összes domain listázása

Visszaadja a fiókjában regisztrált domaineket, 25 oldalonként. A listában nincsenek szűrők.

Szükséges engedély: domains:list

Példa kérés

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/domains/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

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

response = requests.get(url, headers=headers)
for domain in response.json()["results"]:
    print(domain["domain_name"], domain["status"], domain["expiration_date"])
const response = await fetch('https://admin.vps.org/api/v1/domains/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

Példaválasz

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
      "domain_name": "example.com",
      "status": "active",
      "registrar": "dynadot",
      "registration_date": "2026-01-15T10:30:00Z",
      "expiration_date": "2027-01-15T10:30:00Z",
      "days_until_expiration": 122,
      "is_expired": false,
      "needs_renewal_soon": false,
      "auto_renew": true,
      "renewal_period_years": 1,
      "registration_price": "12.64",
      "renewal_price": "12.64",
      "whois_privacy": true,
      "nameserver1": "ns1.vps.org",
      "nameserver2": "ns2.vps.org",
      "nameserver3": "ns3.vps.org",
      "nameserver4": null,
      "transfer_lock": true,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-09-01T08:12:40Z"
    }
  ]
}

Válaszmezők

Mező Típus Leírás
uuid string A többi domain végpontban használt tartományazonosító
status string active, pending, expired, cancelled, transferred
registrar string Regisztrátor: a tartomány a következő helyen található:
registration_date, expiration_date datetime A domain regisztrációja és lejárata után a lejárati idő érvénytelen lehet.
days_until_expiration integer | null A lejárati dátumig eltelt teljes nap, negatív egyszer lejárt
is_expired, needs_renewal_soon boolean Hogy a tartomány lejárt-e, és hogy a következő 30 napban lejár-e
auto_renew, renewal_period_years boolean, integer Hogy a tartomány automatikusan megújul-e, és hány évig
registration_price, renewal_price string Árak USD-ban tizedessorként
whois_privacy, transfer_lock boolean WHOIS adatvédelmi és regisztrációs transzfer zár beállításai
nameserver1 to nameserver4 string | null A tartomány névszerverei
created_at, updated_at datetime A rekord létrehozása és utolsó változtatása (ISO 8601, UTC)
KAP /api/v1/domains/{uuid}/

A domain részletei

Visszaad egy domain objektumot a fenti mezőkkel.

Szükséges engedély: domains:list

curl -X GET "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Válasz állapotkódok

200 Siker
404 Nem található, vagy más számlához tartozik.
HÓNAPPAL KÉSŐBB /api/v1/domains/search/

Keresési tartomány elérhetősége

Ellenőrizze, hogy egy név elérhető-e 20 népszerű kiterjesztésen keresztül (com, net, org, io, dev, co, app, ai and more), valamint a megadott kiterjesztésen keresztül, ha nincs köztük. Eredmények a pontos meccstel kezdődnek, majd a rendelkezésre álló nevek, majd a felvett nevek.

Szükséges engedély: domains:search

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

Paraméter Típus Kívánt Leírás
domain string Igen Egy név kiterjesztéssel vagy anélkül, például mysite vagy mysite.com (2-63 karakter)

Példa kérés

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/domains/search/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "mysite.com"}'
import requests

url = "https://admin.vps.org/api/v1/domains/search/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers, json={"domain": "mysite.com"})
for result in response.json()["results"]:
    if result["available"]:
        print(result["domain"], result["registration_price"], result["renewal_price"])

Példaválasz

{
  "results": [
    {
      "domain": "mysite.com",
      "available": false,
      "price": null,
      "registration_price": null,
      "renewal_price": null,
      "tld": "com",
      "is_exact_match": true
    },
    {
      "domain": "mysite.dev",
      "available": true,
      "price": 17.24,
      "registration_price": 17.24,
      "renewal_price": 17.24,
      "tld": "dev",
      "is_exact_match": false
    }
  ],
  "base_domain": "mysite",
  "search_count": 20
}

Az árak USD-ben egy évig vannak megadva, és nem állnak rendelkezésre olyan nevek. Az árak illusztrálják.

Válasz állapotkódok

200 Siker
400 Hiányzó tartomány, vagy betűktől, számjegyektől és kötőjelektől eltérő karaktereket tartalmaz
500 A regisztrátor keresése sikertelen volt.
HÓNAPPAL KÉSŐBB /api/v1/domains/register/

Új domain regisztrálása

A domain regisztrációja és a mentett fizetési mód ára. A rendelkezésre állás és az ár a regisztrációs számon a díj előtt is ellenőrizhető. A regisztráló elérhetőségét az Ön számla profiljából veszik. Ha a regisztrációs felhasználó a díj megfizetése után elutasítja a regisztrációt, a fizetést visszatérítik.

Szükséges engedély: domains:register (domainek szerint megadva:*)

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

Paraméter Típus Kívánt Leírás
domain string Igen A teljes domain név, beleértve annak kiterjesztését, például a.com
years integer Nem. Regisztráció ideje: 1-10 (alapértelmezett 1) Az ár az éves ár idő év..ai igényel legalább 2 év; kisebb érték visszatér 400. 
curl -X POST "https://admin.vps.org/api/v1/domains/register/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "mysite.dev", "years": 1}'

Példaválasz

{
  "success": true,
  "domain_uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
  "domain_name": "mysite.dev",
  "message": "mysite.dev registered successfully!"
}

Válasz állapotkódok

201 Domainregisztrálva
400 Érvénytelen tartomány, már nem elérhető tartomány, az ár nem ellenőrizhető, elavult fizetési mód, vagy a fizetés sikertelen
402 Nincs fizetési mód az aktában, vagy kifizetetlen számlák
500 A fizetés nem sikerült feldolgozni, vagy a regisztrátor a regisztrációt a fizetés után elutasította. A második esetben a hibaüzenet azt mondja, hogy a visszatérítés ment át.
HÓNAPPAL KÉSŐBB /api/v1/domains/{uuid}/renew/

Újjáépíteni egy tartományt

Megújítja a tartományt és minden évben a megújulási_árát a mentett fizetési módra terheli.

Szükséges engedély: domains:renew

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

Paraméter Típus Kívánt Leírás
years integer Nem. Hozzáadandó évek, 1-től 10-ig (alapértelmezett 1) 
curl -X POST "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/renew/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"years": 1}'
{
  "success": true,
  "domain_uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
  "new_expiration": "2028-01-15T10:30:00+00:00",
  "message": "example.com renewed successfully for 1 year(s)!"
}

Válasz állapotkódok

200 Megújított tartomány
400 Érvénytelen évek, a tartomány felújítási ára, használható fizetési mód vagy a fizetés sikertelen
404 Nem található, vagy más számlához tartozik.
500 A fizetés nem sikerült feldolgozni, vagy a fizetést végrehajtották, de a regisztrátor megújítása nem sikerült.
PUT /api/v1/domains/{uuid}/nameservers/

Névszerverek frissítése

Beállítja a domain névszervereit a regisztrátornál, és visszaadja a frissített domain objektumot. A DNS kezeléséhez használja az ns1.vps.org, ns2.vps.org és ns3.vps.org tartományt és hozzon létre egy zónát a domain számára.

Szükséges engedély: domains:update

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

Paraméter Típus Kívánt Leírás
nameserver1 string Igen Elsődleges névszerver hostname
nameserver2, nameserver3, nameserver4 string Nem. Kiegészítő névszerver név 
curl -X PUT "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/nameservers/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"nameserver1": "ns1.vps.org", "nameserver2": "ns2.vps.org", "nameserver3": "ns3.vps.org"}'

Válasz állapotkódok

200 Névszerverek frissítve; a test a domain objektum
400 névszerver1 hiányzik
404 Nem található, vagy más számlához tartozik.
500 A frissítés sikertelen; a szerv hiba és üzenetmezők
PUT /api/v1/domains/{uuid}/auto-renew/

Automatikus megújítás bekapcsolása vagy kikapcsolása

Az automatikus_renew beállításai és a frissített domain objektum visszaadása. Küldés JSON booleanként engedélyezve: bármilyen nem üres string, beleértve a hamis stringet is, automatikusan megújul.

Szükséges engedély: domains:update

curl -X PUT "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/auto-renew/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

Válasz állapotkódok

200 A mentett beállítás; a test a domain objektum
400 a hiányzó
404 Nem található, vagy más számlához tartozik.

Megjegyzések