VPS.org API

Dokumentace REST API

Domény API

Hledat dostupná jména domén, zaregistrovat a obnovit domény, a spravovat jejich jmenovky a auto-obnovení. Domény jsou identifikovány jejich uuid.

Koncové body 7
Základní cesta /api/v1/domains
ZÍSKAT /api/v1/domains/

Zobrazit všechny domény

Vrací domény registrované ve vašem účtu, 25 na stránku. Seznam nemá žádné filtry.

Požadované povolení: domains:list

Příklad žádosti

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říklad odpovědi

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

Pole odpovědí

Pole Typ Popis zboží
uuid string Identifikátor domény použitý v ostatních cílových parametrech domény
status string active, pending, expired, cancelled, transferred
registrar string Vedoucí soudní kanceláře domény je držena na
registration_date, expiration_date datetime Když byla doména registrována a kdy vyprší. expiration_date může být null.
days_until_expiration integer | null Celé dny do data spotřeby, po uplynutí doby platnosti
is_expired, needs_renewal_soon boolean Zda doména vypršela a zda vyprší během následujících 30 dnů
auto_renew, renewal_period_years boolean, integer Zda doména automaticky obnovuje a po kolik let
registration_price, renewal_price string Ceny v USD jako desetinné řetězce
whois_privacy, transfer_lock boolean Nastavení zámku pro přenos a přenos zámků WHOIS
nameserver1 to nameserver4 string | null Jméno domény
created_at, updated_at datetime Když byl záznam vytvořen a naposledy změněn (ISO 8601, UTC)
ZÍSKAT /api/v1/domains/{uuid}/

Získat detaily domény

Vrací jeden objekt domény s polemi nahoře.

Požadované povolení: 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 odpovědi

200 Úspěch
404 Nenalezeno, nebo patří k jinému účtu
POST /api/v1/domains/search/

Dostupnost domény

Kontroluje, zda je jméno k dispozici v rámci cca 20 populárních rozšíření (com, net, org, io, dev, co, app, ai a další), plus rozšíření, které jste napsali, pokud není mezi nimi. Výsledky začínají s přesnou zápas, pak dostupná jména, pak se vzal ty.

Požadované povolení: domains:search

Parametry těla požadavku

Parametr Typ Požadovaný Popis zboží
domain string Ano Název s rozšířením nebo bez něj, například mysite nebo mysite.com (2 až 63 znaků)

Příklad žádosti

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říklad odpovědi

{
  "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 jsou v USD čísla za jeden rok a jsou nulové pro názvy, které nejsou k dispozici. Uvedené ceny jsou ilustrativní.

Kódy stavu odpovědi

200 Úspěch
400 Chybějící doména, nebo obsahuje jiné znaky než písmena, číslice a pomlčky
500 Registrátorův vyhledávač selhal.
POST /api/v1/domains/register/

Registrace nové domény

Zaregistruje doménu a účtuje vám uložený způsob platby. Dostupnost a cena jsou u registrátora zkontrolovány znovu těsně před zaplacením. Kontaktní údaje žadatele o registraci jsou převzaty z vašeho profilu účtu. Pokud registrátor registraci po zaplacení poplatku odmítne, platba se vrátí.

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

Parametry těla požadavku

Parametr Typ Požadovaný Popis zboží
domain string Ano Celé jméno domény včetně jeho rozšíření, například.com
years integer Ne. Registrace, 1 až 10 (výchozí 1). Cena je roční cena krát roky..ai vyžaduje nejméně 2 roky; menší hodnota vrací 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říklad odpovědi

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

Kódy stavu odpovědi

201 Zapsaná doména
400 Neplatná doména, doména již není k dispozici, cena nemohla být ověřena, zastaralá platební metoda, nebo platba selhala
402 Žádná platební metoda ve spisu nebo nezaplacené faktury
500 Platba nemohla být zpracována, nebo registrátor odmítl registraci po zaplacení. V druhém případě chybová zpráva říká, zda vrácení prošlo.
POST /api/v1/domains/{uuid}/renew/

Obnovit doménu

Obnoví doménu a naúčtuje její obnovení_cenu za každý rok na vaši uložený platební metodu.

Požadované povolení: domains:renew

Parametry těla požadavku

Parametr Typ Požadovaný Popis zboží
years integer Ne. Roky, které přidáme, 1 až 10 (výchozí 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 odpovědi

200 Obnovená doména
400 Neplatné roky, žádná cena obnovení domény, žádná použitelná platební metoda, nebo platba selhala
404 Nenalezeno, nebo patří k jinému účtu
500 Platba nemohla být zpracována, nebo platba prošla, ale registrace obnovení selhala. Kontaktní podpora v tomto případě.
PUT /api/v1/domains/{uuid}/nameservers/

Aktualizovat jmenovky

Nastaví doménové jmenovky v registrátoru a vrátí aktualizovaný doménový objekt. Chcete-li spravovat DNS s DNS API, použijte ns1.vps.org, ns2.vps.org a ns3.vps.org a vytvořit zónu pro doménu.

Požadované povolení: domains:update

Parametry těla požadavku

Parametr Typ Požadovaný Popis zboží
nameserver1 string Ano Jméno hlavního nameserveru
nameserver2, nameserver3, nameserver4 string Ne. Další jména serveru
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 odpovědi

200 Aktualizované nameservery; tělo je objekt domény
400 nameserver1 chybí
404 Nenalezeno, nebo patří k jinému účtu
500 Aktualizace selhala; tělo má chybová pole a pole zpráv
PUT /api/v1/domains/{uuid}/auto-renew/

Automaticky obnovit nebo vypnout

Nastaví automatické_renew a vrátí aktualizovaný doménový objekt. Odeslání povoleno jako JSON boolean: jakýkoliv neprázdný řetězec, včetně false řetězce, zapne automatické obnovení.

Požadované povolení: 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 odpovědi

200 Nastavení uložené; tělo je objekt domény
400 povoleno chybějící
404 Nenalezeno, nebo patří k jinému účtu

Poznámky