VPS.org API

Ukufaka idokhumende

Ama-domains API

Hlola igama lendawo elikhona, bhalisela futhi uvuselele izindawo, futhi uphatha izisebenzisi zegama kanye nokuvuselelwa okuzenzakalelayo. Izizinda ziphawulwa nge-uuid zabo.

Amaphoyinti Okugcina 7
Indlela Eyisisekelo /api/v1/domains
THOLA /api/v1/domains/

Bhala Zonke Izizinda

Ibuyisela amakheli abhalisiwe kwi-akhawunti yakho, 25 ngamakhasi. Uhlu alunazinhlanzi.

Igunya elidingekayo: domains:list

Isicelo Sesibonelo

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

Impendulo Yesibonelo

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

Izinkambu Zempendulo

Isigaba Uhlobo Incazelo
uuid string Isibonisi sethambeka esisetshenziswa kwezinye iziqephu zethambeka
status string active, pending, expired, cancelled, transferred
registrar string Umphathi wendawo egcinwe kuyo
registration_date, expiration_date datetime Lapho ikheli libhaliswe futhi liphelile. expiration_date ingabe ingekho.
days_until_expiration integer | null Izinsuku zonke kuze kube yisikhathi sokuphelelwa_ngokuqediwe, ezibi uma ziphelile
is_expired, needs_renewal_soon boolean Uma ngabe ikheli liphelelwe yisikhathi, noma ngabe liphelelwe yisikhathi phakathi kwezinyanga ezilandelayo ezingu-30
auto_renew, renewal_period_years boolean, integer Uma ngabe ikheli livuselelwa ngokuzenzakalela, futhi lihlala iminyaka eminingi
registration_price, renewal_price string Amantengo e-USD njengezinhlamvu ezingu-10
whois_privacy, transfer_lock boolean Ukuvikelwa kwe-WHOIS kanye nezinhlelo zokuvala ukudluliswa kobhalisi
nameserver1 to nameserver4 string | null Igama lesisebenzisi sendawo
created_at, updated_at datetime Lapho isingeniso sidalwa futhi sishintshwe (ISO 8601, UTC)
THOLA /api/v1/domains/{uuid}/

Thola imingwane yendawo

Ibuyisela isihloko esisodwa sendawo eseceleni namafasitela aphezulu.

Igunya elidingekayo: domains:list

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

Amakhodi Esimo Sempendulo

200 Uphumelela
404 Ayitholakali, noma ikhona kwezinye i-akhawunti
ISITHUTHUKO /api/v1/domains/search/

Uhlu lwendawo etholakalayo

Ibheka ukuthi ngabe igama likhona phakathi kwezinhlamvu ezithandwayo ezingu-20 (com, net, org, io, dev, co, app, ai nezinye eziningi), kanye nezinhlamvu obhalela kuzo uma azikho phakathi kwazo. Izibalo ziqala ngokufana okucacile, bese kuvela amagama akhona, bese kuvela athathwe.

Igunya elidingekayo: domains:search

Cela Amapharamitha Omzimba

Amapharamitha Uhlobo Kuyadingeka Incazelo
domain string Yebo Igama elinama- noma alina- isiqephu, isibonelo mysite noma mysite.com (izimpawu ezingu-2 kuya ku-63)

Isicelo Sesibonelo

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

Impendulo Yesibonelo

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

Amantengo amanani emali e-USD ngonyaka owodwa futhi ayikho kumagama angekho. Amantengo abonisa ukukhombisa.

Amakhodi Esimo Sempendulo

200 Uphumelela
400 Ikheli elilahlekile, noma liqukethe amagama ngaphandle kwamaphetshana, ama-digits ne-hyphens
500 Ukuhlola umphathi akuphumelelanga. Zama futhi kamuva.
ISITHUTHUKO /api/v1/domains/register/

Bhalisa Isizinda Esisha

Ibhalisa ikheli le-domain futhi ikhokhisa indlela yakho yokhokha egcinwe. Ukungena nentengo zihlolwa futhi nge-registrator ngaphambi kokukhokhisa. Ulwazi lokuxhumana noregistrator luthathwa kusuka kwiprofayili yakho ye-akhawunti. Uma i-registrator ichaza ukubhaliswa ngemuva kokukhokhisa, inkokhelo ibuyiselwa.

Igunya elidingekayo: domains:register (inikezelwe yizindawo:*)

Cela Amapharamitha Omzimba

Amapharamitha Uhlobo Kuyadingeka Incazelo
domain string Yebo Igama lendawo eligcwele kufaka phakathi isiqephu sayo, isibonelo example.com
years integer Akukho Isikhathi sokufaka isicelo, 1 kuya ku-10 (isimiso 1). Intengo yintengo yonyaka izikhathi zeminyaka..ai idinga cishe iminyaka emi-2; inani elincane libuyisela 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}'

Impendulo Yesibonelo

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

Amakhodi Esimo Sempendulo

201 Ikheli elibhalisiwe
400 Ikheli elingalunganga, ikheli alikho, intengo ayikwazi ukuqinisekiswa, indlela yokukhokha edlulele, noma inkokhelo ayiphumelelanga
402 Akukho indlela yokukhokha kwifayela, noma amafayela angakhokhwa
500 Ukhokhi ungasebenzisi, noma umnikazi we-akhawunti ukhansele ubhaliso ngemuva kokwethula imali. Kulesi simo sesithathu umlayezo wephutha uchaza ukuthi ngabe ukubuyiselwa imali kwadlula.
ISITHUTHUKO /api/v1/domains/{uuid}/renew/

Igama lendawo

Ivuselela ikheli le-imeyili futhi ikhokhisa i-renewal_price yayo ngonyaka ngamunye ngendlela yakho yokukhokha egciniweyo.

Igunya elidingekayo: domains:renew

Cela Amapharamitha Omzimba

Amapharamitha Uhlobo Kuyadingeka Incazelo
years integer Akukho Iminyaka edingekayo ukungeza, 1 kuya ku-10 (isimiso 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)!"
}

Amakhodi Esimo Sempendulo

200 Ikheli livuselelwe
400 Iminyaka engasebenziyo, akukho ntengo yokuvuselela ikheli, akukho indlela yokukhokha esetshenziswayo, noma ukukhokha akuphumelelanga
404 Ayitholakali, noma ikhona kwezinye i-akhawunti
500 Ukhokha akukwazanga ukucutshungulwa, noma ukhokha kwadlula kodwa ukuvuselelwa kwe-registrar akuphumelelanga. Xhumana nosizo uma kwenzeka lokhu.
PUT /api/v1/domains/{uuid}/nameservers/

Igama lesisebenzisi:

Imisa izisebenzisi zegama lendawo ebhalisiwe futhi ibuyisela isihloko sendawo esivuselelwe. Ukulawula i-DNS nge-DNS API, sebenzisa i-ns1.vps.org, i-ns2.vps.org ne-ns3.vps.org bese udala indawo yendawo.

Igunya elidingekayo: domains:update

Cela Amapharamitha Omzimba

Amapharamitha Uhlobo Kuyadingeka Incazelo
nameserver1 string Yebo Igama lokumamela lomhlinzeki wegama
nameserver2, nameserver3, nameserver4 string Akukho Igama lesisebenzisi segama elingeziwe
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"}'

Amakhodi Esimo Sempendulo

200 Izisebenzisi-gama zivuselelwe; isiqu siyinto yendawo
400 i-nameserver1 ilahlekile
404 Ayitholakali, noma ikhona kwezinye i-akhawunti
500 Ukuvuselelwa akuphumelelanga; isiqu sinephutha kanye nemibukiso yezindawo
PUT /api/v1/domains/{uuid}/auto-renew/

Misa noma khubaza ukuvuselelwa okuzenzakalelayo

Imisa i-auto_renew futhi ibuyisela i-domain object evuselelwe. Thumela isebenza njenge-JSON boolean: noma iyiphi umbhalo ongangenalutho, kufaka phakathi umbhalo ongalungile, uvula ukuphindaphinda okuzenzakalelayo.

Igunya elidingekayo: 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}'

Amakhodi Esimo Sempendulo

200 Isilungiselelo sigcinwe; isiqu siyinto yendawo
400 igunyazwe lilahlekile
404 Ayitholakali, noma ikhona kwezinye i-akhawunti

Amabhukwana