VPS.org API

REST API Xuquuqda

Domains API

Raadinta magacyada domains la heli karo, diiwaan iyo domains cusbooneysiiya, iyo maamulo servers magacooda iyo auto-cusub. Domains waxaa lagu aqoonsan yahay uuid.

Dhammaadka 7
Waddo Saldhig ah /api/v1/domains
HEL /api/v1/domains/

Liis garee Dhammaan Domains-ka

Ku soo laabtay domains diiwaangashan xisaabtaada, 25 bogga. Liiska ma laha filters.

Xuquuqda loo baahan yahay: domains:list

Codsi Tusaale ah

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

Jawaabta Tusaale

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

Goobaha Jawaabta

Isku-darka Nooca Tilmaamaha
uuid string Domain aqoonsi loo isticmaalo in domain kale endpoints
status string active, pending, expired, cancelled, transferred
registrar string Registrar domain waxaa lagu qabtay
registration_date, expiration_date datetime Marka domain waxaa la diiwaangeliyey iyo marka ay dhamaato. expiration_date waa null noqon kartaa.
days_until_expiration integer | null Maalmaha oo dhan ilaa expiration_date, negative markuu dhamaaday
is_expired, needs_renewal_soon boolean Haddii domain waa dhamaatay, iyo haddii ay dhamaato gudahood 30 maalmood ee soo socda
auto_renew, renewal_period_years boolean, integer Haddii domain si otomaatig ah u cusbooneysiiya, iyo inta sano
registration_price, renewal_price string Qiimaha USD sida strings decimal
whois_privacy, transfer_lock boolean Goobaha sirta WHOIS iyo diiwaangelinta wareejinta
nameserver1 to nameserver4 string | null Xidhiidhka cinwaanka
created_at, updated_at datetime Marka diiwaanka la abuuray iyo markii ugu dambeysay ee la badalay (ISO 8601, UTC)
HEL /api/v1/domains/{uuid}/

Ka hel faahfaahinta Domain

Ku soo laabta mid domain wax la goobaha kor ku xusan.

Xuquuqda loo baahan yahay: domains:list

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

Koodhadhka Xaaladda Jawaab celinta

200 Guul
404 Ma la helin, ama waxay ka tirsan tahay xisaab kale
BOOQO /api/v1/domains/search/

Raadinta Domain Availability

Ka hubi haddii magacu yahay mid la heli karo oo dhan ku saabsan 20 extensions caan ah (com, net, org, io, dev, co, app, ai iyo in ka badan), iyo sidoo kale ballaadhinta aad ku qortay haddii ayna ka mid ah. Natiijooyinka la bilaabaan la midka saxda ah, markaas magacyada la heli karo, markaas ka qaaday kuwa.

Xuquuqda loo baahan yahay: domains:search

Codso Cabbirrada Jirka

_Barnaamijyada Nooca Loo baahan yahay Tilmaamaha
domain string Haa Magaca la ama aan la kordhinta, tusaale ahaan mysite ama mysite.com (2 ilaa 63 xarfo)

Codsi Tusaale ah

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

Jawaabta Tusaale

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

Qiimaha waa tirada USD sanadka oo dhan iyo waa null for magacyada aan la heli karin. Qiimaha la muujiyay waa tusaale.

Koodhadhka Xaaladda Jawaab celinta

200 Guul
400 Domain la'aan, ama waxaa ku jira xarfaha kale oo aan aheyn xarfaha, lambarada iyo isku xiraha
500 Baaritaankii diiwaanka wuu fashilmay. Dib u daawso ka dib.
BOOQO /api/v1/domains/register/

Diiwaangeli Domain Cusub

Waa in aad ka diiwaan gashan tahay domain iyo lacagaha aad kaydin qaabka lacag bixinta. Availability iyo qiimaha la hubiyo la diiwaangashan mar kale ka hor inta aan la soo bixi. The registrant xiriirka macluumaadka waxaa laga qaaday profile aad xisaabta. Haddii diiwaangashan diido diiwaangelinta ka dib markii la soo bixi, lacagta la soo celiyo.

Xuquuqda loo baahan yahay: domains:register (oo ay bixiyeen domains: *)

Codso Cabbirrada Jirka

_Barnaamijyada Nooca Loo baahan yahay Tilmaamaha
domain string Haa Magaca domain buuxa oo ay ku jiraan ballaadhinta, tusaale ahaan example.com
years integer Ha Waqtiga diiwaangelinta, 1 ilaa 10 (default 1). Qiimaha waa qiimaha sanadlaha ah mar kasta oo sano ah..ai u baahan tahay ugu yaraan 2 sano; qiimaha yar ayaa ku soo laabtay 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}'

Jawaabta Tusaale

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

Koodhadhka Xaaladda Jawaab celinta

201 Domain diiwaangashan
400 Domain aan sharci ahayn, domain ka dibna la heli karo, qiimaha ma la xaqiijin karo, habka lacag bixinta ka hor, ama lacag bixinta ku fashilantay
402 Ma jiro habka lacag bixinta ee faylka, ama xisaabaadka aan la bixin
500 Lacagta ma aysan awoodin in la xaliyo, ama diiwaanka diiday diiwaangelinta ka dib markii lacagta. Haddii kale, fariinta qaladku wuxuu leeyahay haddii lacagta la soo celiyo ay soo martay.
BOOQO /api/v1/domains/{uuid}/renew/

Ku dar Domain

Renew domain iyo charges uu renewal_price sanad kasta si aad u kaydsan habka lacag bixinta.

Xuquuqda loo baahan yahay: domains:renew

Codso Cabbirrada Jirka

_Barnaamijyada Nooca Loo baahan yahay Tilmaamaha
years integer Ha Sannadaha in la kordhiyo, 1 ilaa 10 (default 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)!"
}

Koodhadhka Xaaladda Jawaab celinta

200 Domain la cusbooneysiiyay
400 Sannadaha aan sharci ahayn, qiimaha dib u cusbooneysiinta ee domain, qaabka lacag bixinta ee aan la isticmaali karin, ama lacag bixinta oo fashilantay
404 Ma la helin, ama waxay ka tirsan tahay xisaab kale
500 Lacagta ma uusan awoodin in la xaliyo, ama lacagta ayaa ka soo baxay laakiin dib u cusbooneysiin registrar ku fashilantay. Support Contact in arrintaas.
PUT /api/v1/domains/{uuid}/nameservers/

Ku cusbooneysiiya server-ka magacyada

Si aad u maamulo DNS la API DNS, isticmaal ns1.vps.org, ns2.vps.org iyo ns3.vps.org iyo abuuro dhul u ah domain.

Xuquuqda loo baahan yahay: domains:update

Codso Cabbirrada Jirka

_Barnaamijyada Nooca Loo baahan yahay Tilmaamaha
nameserver1 string Haa Magaca martida server-ka
nameserver2, nameserver3, nameserver4 string Ha Magaca server-ka 
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"}'

Koodhadhka Xaaladda Jawaab celinta

200 servers-ka magacyada la cusbooneysiiyay; jirka waa waxa domain-ka ah
400 server1 magacu ka maqan yahay
404 Ma la helin, ama waxay ka tirsan tahay xisaab kale
500 Cusboonaysiinta way fashilantay; jirka waxaa ku jira khaladaad iyo meelaha fariimaha
PUT /api/v1/domains/{uuid}/auto-renew/

Ku dar ama ka saar dib u cusbooneysiinta otomaatiga ah

Sets auto_renew oo ku soo laabtay waxa domain la cusbooneysiiyay. Dib u soo dir la awoodi karo sida JSON boolean: kasta oo aan xariiqyada aan buuxin, oo ay ku jiraan xariiqyada beenta ah, u wareegaya auto-soo celinta on.

Xuquuqda loo baahan yahay: 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}'

Koodhadhka Xaaladda Jawaab celinta

200 Settings kaydsan; jirka waa domain wax
400 la awooday oo ka maqan
404 Ma la helin, ama waxay ka tirsan tahay xisaab kale

Xigasho