VPS.org API

Uxwebhu lwe-REST API

Iindawo ze-API

Khangela amagama eethambeka afumanekayo, ubhalisa nohlaziya iithambeka, kwaye uphatha iimeva zabo zegama nohlaziyo oluzenzekelayo. Iithambeka zichazwa yi-uuid yabo.

Iindawo zokugqibela 7
Indlela Esisiseko /api/v1/domains
FUMANA /api/v1/domains/

Dwelisa Zonke iiDomain

Ibuyisela iinkalo ezibhalisiweyo kwi akhawunti yakho, 25 kwiphepha ngalinye. Uluhlu alunazicebo lokucoca ulwelo.

Iimvume ezifunekayo: domains:list

Isicelo somzekelo

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 yoMzekelo

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

IiNdawo zeMpendulo

Iindawo Uhlobo Inkcazelo
uuid string Umchazi wethambeka osetyenziswa kwezinye iindawo zokuphelela zethambeka
status string active, pending, expired, cancelled, transferred
registrar string Umbhalisi wendawo egcinwe kuyo
registration_date, expiration_date datetime Xa idomain ibhaliswe kwaye xa iphela. expiration_date ingaba yi-null.
days_until_expiration integer | null Iintsuku ezipheleleyo de kube_kuphelelwe lixesha, ezi negative xa ziphelelwe lixesha
is_expired, needs_renewal_soon boolean Nokuba ngaba i-domain iphelile, nokuba iphelile ngaphakathi kweentsuku ezilandelayo ezi-30
auto_renew, renewal_period_years boolean, integer Nokuba ngaba i-domain ihlaziya ngokuzenzekelayo, kwaye ihlala iminyaka embalwa
registration_price, renewal_price string Iixabiso kwi-USD njengemisonto yeshumi
whois_privacy, transfer_lock boolean I-WHOIS yobumfihlo kunye nemimiselo yotshixo lokudlulisa umbhalisi
nameserver1 to nameserver4 string | null Igama lendawo yokugcina efihlakeleyo
created_at, updated_at datetime Xa irekhodi lidalwa kwaye litshintshwe ekupheleni (ISO 8601, UTC)
FUMANA /api/v1/domains/{uuid}/

Fumana Iinkcukacha Zothambeka

Ibuyisela enye into yethambeka ngemihlaba ephezulu.

Iimvume ezifunekayo: domains:list

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

Iikhowudi zeMeko yokuphendula

200 Uphumelele
404 Ayifumanekanga, okanye imalunga ne-akhawunti enye
I-POST /api/v1/domains/search/

Igama lethambeka:

Ikhangela ukuba igama lifumaneka kwiintshukumo ezili-20 ezithandwayo (com, net, org, io, dev, co, app, ai kunye nezinye), kunye nentlanganiso obhale ngayo ukuba ayikho phakathi kwabo. Iimpumelelo ziqala ngokuhambelana okuthe ngqo, emva koko amagama afumanekayo, emva koko athathwe.

Iimvume ezifunekayo: domains:search

Cela iiParamitha zoMzimba

Iparamitha Uhlobo Kufuneka Inkcazelo
domain string Ewe Igama elinomyalezo okanye olungamkeli, umzekelo. mysite okanye mysite.com (2 ukuya ku-63 uphawu)

Isicelo somzekelo

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 yoMzekelo

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

Iixabiso ziinombolo kwi-USD yonyaka omnye kwaye ziyi-null kwigama elingekhoyo. Iixabiso ezibonisiweyo zibonisa umzekelo.

Iikhowudi zeMeko yokuphendula

200 Uphumelele
400 Ithambeka elilahlekileyo, okanye liquka iimpawu ngaphandle kweeleta, amanani kunye ne-hyphens
500 Ukukhangela umbhalisi akuphumelelanga. Zama kwakhona kamva.
I-POST /api/v1/domains/register/

Bhalisa iDomain entsha

Ibhalisa ithambeka kwaye ihlawulisa indlela yakho yohlawulo egciniweyo. Unikezelo kunye nexabiso livavanywa kwakhona nombhalisi phambi kokuba kuhlawulwe. Iinkcukacha zoqhagamshelwano lombhalisi zithathwa kwiprofayili yeakhawunti yakho. Ukuba umbhalisi uyeka ubhaliso emva kokutshatyalaliswa, uhlawulwe kwakhona.

Iimvume ezifunekayo: domains:register (inikezelwe ziindawo:*)

Cela iiParamitha zoMzimba

Iparamitha Uhlobo Kufuneka Inkcazelo
domain string Ewe Igama lethambeka elipheleleyo eliquka uluhlu lwayo, umzekelo example.com
years integer Akukho nanye Registration period, 1 to 10 (default 1). The price is the yearly price times years. .ai requires at least 2 years; a smaller value returns 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 yoMzekelo

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

Iikhowudi zeMeko yokuphendula

201 Ithambeka Elibhalisiweyo
400 Ithambeka elingasebenziyo, ithambeka alikho, ixabiso alikwazanga kuqinisekiswa, indlela yohlawulo ephelelwe lixesha, okanye unikezelo aluphumelelanga
402 Akukho ndlela yohlawula kwifayili, okanye iinfaktura ezingahlawulwanga
500 Imali ayikwazanga kugqitywa, okanye umbhalisi wayeka ubhaliso emva kokufumana imali. Kwimeko yesibini umyalezo wempazamo uthetha ukuba ibuyiselo lemali ligqityiwe.
I-POST /api/v1/domains/{uuid}/renew/

Igama lethambeka

Ivuselela ithambeka kwaye ihlawulisa i-renewal_price yayo ngonyaka ngamnye kwindlela yakho yohlawulo egciniweyo.

Iimvume ezifunekayo: domains:renew

Cela iiParamitha zoMzimba

Iparamitha Uhlobo Kufuneka Inkcazelo
years integer Akukho nanye Iminyaka emayidityaniswe, 1 ukuya 10 (okwendalo 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)!"
}

Iikhowudi zeMeko yokuphendula

200 Ithambeka Elihlaziyiweyo
400 Iminyaka engasebenziyo, akukho xabiso lokuvuselela lethambeka, akukho ndlela yohlawula esetyenziswayo, okanye uhlawulwe ngokungaphumelelanga
404 Ayifumanekanga, okanye imalunga ne-akhawunti enye
500 Imali ayikwazanga ukuqhubekekiswa, okanye imali igqithe kodwa uhlaziyo lobhalisi aluphumelelanga. Qhagamshelana noncedo kulo mzekelo.
PUT /api/v1/domains/{uuid}/nameservers/

Igama Lomncedisi

Imisela iiseva zegama lethambeka kumbhalisi kwaye ibuyisela into ehlaziyiweyo yethambeka. Ukuphatha i-DNS nge-DNS API, sebenzisa i-ns1.vps.org, i-ns2.vps.org ne-ns3.vps.org kwaye udale ummandla wethambeka.

Iimvume ezifunekayo: domains:update

Cela iiParamitha zoMzimba

Iparamitha Uhlobo Kufuneka Inkcazelo
nameserver1 string Ewe Igama lenginginya yeseva yegama
nameserver2, nameserver3, nameserver4 string Akukho nanye Igama lenginginya yeseva yegama elingaphezulu 
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"}'

Iikhowudi zeMeko yokuphendula

200 Nameservers updated; the body is the domain object
400 i-nameserver1 ilahlekile
404 Ayifumanekanga, okanye imalunga ne-akhawunti enye
500 Ukuhlaziya akuphumelelanga; isiqu sinempazamo kunye nemihlaba yomyalezo
PUT /api/v1/domains/{uuid}/auto-renew/

Yenza uhlaziyo oluzenzekelayo lusebenze okanye alusebenze

Imisela i-auto_renew kwaye ibuyisela into ehlaziyiweyo yendawo. Thumela isebenze njenge-JSON boolean: nayiphi na imisonto engasebenziyo, kubandakanya umsonto ongalunganga, ubuyisela ukuphinda usebenze ngokuzenzekelayo.

Iimvume ezifunekayo: 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}'

Iikhowudi zeMeko yokuphendula

200 Izicwangciso zigcinwe; isiqu siyinto yethambeka
400 i-enabled missing
404 Ayifumanekanga, okanye imalunga ne-akhawunti enye

Iinkcukacha