VPS.org API

REST API dokumentacija

API domen

Iščite razpoložljiva imena domen, registrirajte in obnovite domene, in upravljajte njihove serverje imen in avto-renoviranje. Domene so identificirani po njihovem uuid.

Končne točke 7
Osnovna pot /api/v1/domains
PRIDOBITE /api/v1/domains/

Seznam vseh domen

Vrne domene, registrirane na vašem računu, 25 na stran. Seznam nima filtrov.

Zahtevano dovoljenje: domains:list

Primer zahteve

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

Primer odgovora

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

Polja za odgovor

Polje Vrsta Opis
uuid string Identifikator domene, uporabljen v drugih opazovanih točkah domene
status string active, pending, expired, cancelled, transferred
registrar string Sodni tajnik, na katerem je področje
registration_date, expiration_date datetime Ko je domena registrirana in ko preneha. Trajnost_ datuma je lahko ničla.
days_until_expiration integer | null Celotni dnevi do datuma izteka roka uporabnosti, negativni po izteku roka uporabnosti
is_expired, needs_renewal_soon boolean Ali je domena potekla in ali izteče v naslednjih 30 dneh
auto_renew, renewal_period_years boolean, integer Ali domena samodejno obnovi in koliko let
registration_price, renewal_price string Cene v USD kot decimalne nize
whois_privacy, transfer_lock boolean Nastavitve zasebnosti in registrske ključavnice za prenos
nameserver1 to nameserver4 string | null Strežniki imen domene
created_at, updated_at datetime Ko je bil zapis ustvarjen in nazadnje spremenjen (ISO 8601, UTC)
PRIDOBITE /api/v1/domains/{uuid}/

Poišči podrobnosti domene

Vrne eno domeno objekta z zgornjimi polji.

Zahtevano dovoljenje: domains:list

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

Kode stanja odgovora

200 Uspeh
404 Ni najden ali pripada drugemu računu
POST /api/v1/domains/search/

Išči razpoložljivost domene

Preverja, ali je ime na voljo prek približno 20 priljubljenih razširitev (com, net, org, io, dev, co, app, ai in več), plus razširitev, ki ste jo vpisali, če ni med njimi. Rezultati se začnejo z natančno ujemanjem, potem razpoložljiva imena, nato pa z eno.

Zahtevano dovoljenje: domains:search

Zahtevajte parametre telesa

Parameter Vrsta Zahtevano Opis
domain string Da Ime z razširitvijo ali brez nje, na primer mysite ali mysite.com (2 do 63 znakov)

Primer zahteve

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

Primer odgovora

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

Cene so številke v USD za eno leto in so nič za imena, ki niso na voljo. Prikazane cene so ilustrativne.

Kode stanja odgovora

200 Uspeh
400 Manjkajoča domena ali vsebuje znake, ki niso črke, števke in risnice
500 Ponovno ponovite.
POST /api/v1/domains/register/

Registriraj novo domeno

Registrira domeno in stroške, ki jih je prihranil vaš način plačila. Dobavljivost in cena se ponovno preverita s registrarom tik pred naplato. Podatki za registracijo so iz vašega profila. Če registrar zavrne registracijo po plačilu, se plačilo vrne.

Zahtevano dovoljenje: domains:register (razvrščeno po domenah:*)

Zahtevajte parametre telesa

Parameter Vrsta Zahtevano Opis
domain string Da Celotno ime domene, vključno z njegovo razširitvijo, na primer.com
years integer Ne Registracijsko obdobje, 1 do 10 (privzeto 1). Cena je letna cena čas let..ai zahteva vsaj 2 leti; manjša vrednost vrne 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}'

Primer odgovora

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

Kode stanja odgovora

201 Registrirana domena
400 Neveljavna domena, domena ni več na voljo, cene ni bilo moč preveriti, zastarela plačilna metoda ali plačilo ni uspelo
402 Brez načina plačila v datoteki ali neplačanih računih
500 Plačila ni bilo mogoče obdelati, ali pa je registracija registracije po plačilu zavrnil. V drugem primeru sporočilo o napaki navaja, ali je nadomestilo potekalo.
POST /api/v1/domains/{uuid}/renew/

Obnovi domeno

Obnovi domeno in naplačuje svojo obnovitev_cene za vsako leto na prihranjen način plačila.

Zahtevano dovoljenje: domains:renew

Zahtevajte parametre telesa

Parameter Vrsta Zahtevano Opis
years integer Ne Leta za dodajanje, 1 do 10 (privzeto 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)!"
}

Kode stanja odgovora

200 Obnovljena domena
400 Neveljavna leta, brez cene obnovitve za domeno, brez uporabe metode plačila ali plačila ni uspelo
404 Ni najden ali pripada drugemu računu
500 Plačila ni bilo mogoče obdelati ali pa je bilo plačilo preplačano, vendar je obnova registra spodletela. V tem primeru je bila podpora za stike.
PUT /api/v1/domains/{uuid}/nameservers/

Posodobi strežnike imen

Nastavi strežnike za ime domene na registru in vrne posodobljene predmete domene. Za upravljanje DNS z DNS API uporabite ns1. vps.org, ns2. vps.org in ns3. vps.org in ustvarite območje za domeno.

Zahtevano dovoljenje: domains:update

Zahtevajte parametre telesa

Parameter Vrsta Zahtevano Opis
nameserver1 string Da Ime imenskega strežnika
nameserver2, nameserver3, nameserver4 string Ne Dodatni imeni imeniki strežnika
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"}'

Kode stanja odgovora

200 Posodobljeni strežniki imen; telo je predmet domene
400 server ime1 manjka
404 Ni najden ali pripada drugemu računu
500 Posodobitev ni uspela; truplo ima polja za napake in sporočila
PUT /api/v1/domains/{uuid}/auto-renew/

Vklopi ali izklopi samodejno obnovitev

Nastavi samodejno_ ponovno in vrne posodobljeni predmet domene. Pošlji omogočeno kot JSON logično: vsak neprazni niz, vključno z nizom napačno, vklopi samodejno obnovitev.

Zahtevano dovoljenje: 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}'

Kode stanja odgovora

200 Nastavitev shranjena; telo je predmet domene
400 omogočeno manjkanje
404 Ni najden ali pripada drugemu računu

Opombe