VPS.org API

Dokumentácia REST API

API pre domény

Vyhľadávajte voľné názvy domén, registrujte a obnovujte domény, spravujte ich názvové servery a automatické obnovovanie.Domény sú identifikované podľa ich uuid.

Koncové body 7
Základná cesta /api/v1/domains
ZÍSKAŤ /api/v1/domains/

Zoznam všetkých domén

Vráti domény registrované vo vašom účte, 25 na stránku. Zoznam nemá žiadne filtre.

Požadované povolenie: domains:list

Príklad žiadosti

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

Príklad odpovede

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

Polia odpovede

Pole Typ Opis
uuid string Identifikátor domény používaný v ostatných koncových bodoch domény
status string active, pending, expired, cancelled, transferred
registrar string Doména je na predaj!
registration_date, expiration_date datetime Kedy bola doména zaregistrovaná a kedy vyprší platnosť. expiration_date môže byť null.
days_until_expiration integer | null Celé dni do uplynutia platnosti, záporné po vypršaní platnosti
is_expired, needs_renewal_soon boolean Či doména vypršala a či jej platnosť vyprší v priebehu nasledujúcich 30 dní
auto_renew, renewal_period_years boolean, integer Či sa doména automaticky obnovuje a na koľko rokov
registration_price, renewal_price string Ceny v USD ako desatinné reťazce
whois_privacy, transfer_lock boolean Nastavenia ochrany osobných údajov WHOIS a zámku prenosu registrátora
nameserver1 to nameserver4 string | null Názvové servery domény
created_at, updated_at datetime Kedy bol záznam vytvorený a naposledy zmenený (ISO 8601, UTC)
ZÍSKAŤ /api/v1/domains/{uuid}/

Získať podrobnosti o doméne

Vráti jeden objekt domény s poľami vyššie.

Požadované povolenie: domains:list

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

Kódy stavu odpovede

200 Úspech
404 Nenájdené, alebo patrí k inému účtu
POST /api/v1/domains/search/

Vyhľadávanie dostupnosti domény

Skontroluje, či je názov dostupný v približne 20 populárnych príponach (com, net, org, io, dev, co, app, ai a ďalšie), plus prípona, ktorú ste zadali, ak nie je medzi nimi.Výsledky začínajú presnou zhodou, potom dostupnými názvami, potom už použitými.

Požadované povolenie: domains:search

Parametre tela požiadavky

Parameter Typ Povinné Opis
domain string Áno Názov s príponou alebo bez nej, napríklad mysite alebo mysite.com (2 až 63 znakov)

Príklad žiadosti

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"])

Príklad odpovede

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

Ceny sú čísla v USD za jeden rok a pre názvy, ktoré nie sú k dispozícii, sú nulové.

Kódy stavu odpovede

200 Úspech
400 Chýba doména alebo obsahuje znaky iné ako písmená, číslice a spojovníky
500 Vyhľadávanie registrátora zlyhalo. Skúste to znova neskôr.
POST /api/v1/domains/register/

Registrovať novú doménu

Registruje doménu a účtuje poplatok podľa uloženého spôsobu platby. Dostupnosť a cena sa skontrolujú s registrátorom ešte raz tesne pred účtovaním poplatku. Kontaktné údaje registrujúceho sa prevezmú z profilu vášho účtu. Ak registrátor po účtovaní poplatku registráciu zamietne, platba sa vráti.

Požadované povolenie: domains:register (poskytnuté doménami:*)

Parametre tela požiadavky

Parameter Typ Povinné Opis
domain string Áno Celý názov domény vrátane jej prípony, napríklad example.com
years integer Nie Registračné obdobie, 1 až 10 (predvolené 1). Cena je ročná cena krát roky..ai vyžaduje minimálne 2 roky; menšia hodnota vráti 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}'

Príklad odpovede

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

Kódy stavu odpovede

201 Doména zaregistrovaná na predaj
400 Neplatná doména, doména už nie je k dispozícii, cenu sa nepodarilo overiť, zastaraný spôsob platby alebo platba zlyhala
402 Žiadny spôsob platby v súbore alebo nezaplatené faktúry
500 Platba nebola spracovaná, alebo registrátor odmietol registráciu po zaplatení, v druhom prípade chybové hlásenie informuje, či sa vrátenie platby podarilo.
POST /api/v1/domains/{uuid}/renew/

Obnoviť doménu

Obnoví doménu a naúčtuje jej cenu za obnovenie za každý rok pomocou uloženého spôsobu platby.

Požadované povolenie: domains:renew

Parametre tela požiadavky

Parameter Typ Povinné Opis
years integer Nie Počet rokov na pridanie, 1 až 10 (predvolená hodnota 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)!"
}

Kódy stavu odpovede

200 Doména obnovená.
400 Neplatné roky, žiadna cena obnovenia domény, žiadny použiteľný spôsob platby alebo zlyhanie platby
404 Nenájdené, alebo patrí k inému účtu
500 Platba nebola spracovaná alebo platba prebehla, ale registrátor obnovenie zlyhal, v takom prípade kontaktujte podporu.
PUT /api/v1/domains/{uuid}/nameservers/

Aktualizácia názvových serverov

Ak chcete spravovať DNS pomocou rozhrania API DNS, použite ns1.vps.org, ns2.vps.org a ns3.vps.org a vytvorte zónu pre doménu.Nastaví názvové servery domény u registrátora a vráti aktualizovaný objekt domény.Nastaví názvové servery domény u registrátora a vráti aktualizovaný objekt domény.

Požadované povolenie: domains:update

Parametre tela požiadavky

Parameter Typ Povinné Opis
nameserver1 string Áno Názov hostiteľa primárneho názvového servera
nameserver2, nameserver3, nameserver4 string Nie Ďalšie názvy hostiteľa názvového servera
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"}'

Kódy stavu odpovede

200 Nameservery aktualizované; telo je objekt domény
400 nameserver1 chýba
404 Nenájdené, alebo patrí k inému účtu
500 Aktualizácia zlyhala; telo obsahuje polia chyby a hlásenia
PUT /api/v1/domains/{uuid}/auto-renew/

Zapnutie alebo vypnutie automatického obnovenia

Send enabled as a JSON boolean: any non-empty string, including the string false, turns auto-renew on.Odoslať povolené ako JSON boolean: akýkoľvek neprázdny reťazec, vrátane reťazca false, zapne automatické obnovenie.

Požadované povolenie: 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}'

Kódy stavu odpovede

200 Nastavenie uložené; telo je objekt domény
400 Chyba zapnutia
404 Nenájdené, alebo patrí k inému účtu

Poznámky