VPS.org API

PENDEKEZO LA MAFUTA

Domains API

Tafuta majina ya tovuti, andikisho na makazi mapya, na simamia majina yao ya makazi na ya watu. Domains wanatambuliwa kwa uuid wao.

Sehemu za Mwisho 7
Njia ya Msingi /api/v1/domains
PATA /api/v1/domains/

Orodhesha Vikoa Vyote

Arudi tena kwenye maeneo yaliyosajiliwa katika akaunti yako, 25 kwa kila ukurasa.

Ruhusa ya Kuruhusiwa: domains:list

Ombi la Mfano

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

Jibu la Mfano

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

Sehemu za Majibu

Field Aina Maelezo
uuid string Domain shopor atumiwaye katika sehemu nyingine za utawala
status string active, pending, expired, cancelled, transferred
registrar string Mamlaka ya serikali inatawala
registration_date, expiration_date datetime Utawala uliposajiliwa na unapomalizika, kipindi cha mwisho cha kumalizikia_date chaweza kubatilishwa.
days_until_expiration integer | null Siku nzima mpaka mwisho wa_date, hasi viliisha wakati mmoja
is_expired, needs_renewal_soon boolean Kama utawala umekwisha, na kama umekwisha baada ya siku 30
auto_renew, renewal_period_years boolean, integer Iwe ni matumizi ya umeme yanayodumu yenyewe, na miaka mingapi
registration_price, renewal_price string Bei Katika USD Kama Nyuzi za desimali
whois_privacy, transfer_lock boolean TIBA za benki za WHO na msajili huhamisha vikao vya kufuli
nameserver1 to nameserver4 string | null Jina la serikali hiyo ni wahifadhi
created_at, updated_at datetime Rekodi ilipoumbwa na kubadilishwa mara ya mwisho (ISO 8601, UTC)
PATA /api/v1/domains/{uuid}/

Toa Maelezo Mengi Kuhusu Matibabu

Arudi tena uwanja mmoja wenye mashamba yaliyo juu.

Ruhusa ya Kuruhusiwa: domains:list

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

Misimbo ya Hali ya Majibu

200 Mafanikio
404 Si wapatikanao, wala si wa Akaunti jingine
PENDEKEZO /api/v1/domains/search/

Tafuta Uweza wa Kujikinga

Chunguza kama jina linapatikana katika sehemu nyingine 20 hivi (com, neti, org, io, dev, programu, aui na zaidi), pamoja na urefu unaochapa ikiwa si miongoni mwao. Matokeo huanza na mechi hususa, ambayo sasa yaweza kupatikana majina, halafu yachukuliwa.

Ruhusa ya Kuruhusiwa: domains:search

Omba Vigezo vya Mwili

Penseli Aina Inahitajika Maelezo
domain string Ndiyo Kwa mfano, jina lililo na au lisilo na madoido, ni la mtindo wa kuandika au mysite.com (mhusika 2 hadi 63)

Ombi la Mfano

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

Jibu la Mfano

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

Bei za bidhaa ni nambari za Marekani kwa mwaka mmoja na hazitumiki kwa majina ambayo hayapatikani. bei zilizoonyeshwa ni za kielezi.

Misimbo ya Hali ya Majibu

200 Mafanikio
400 Eneo ambalo halijatumiwa, au lina herufi nyingine mbali na herufi, tarakimu na hipani
500 Msajili huyo hakuonekana kuwa mtu halisi na baadaye Retry akachukua hatua.
PENDEKEZO /api/v1/domains/register/

Sajili Kikoa Kipya

Registers a domain and charges your saved payment method. Availability and price are checked with the registrar again right before the charge. The registrant contact details are taken from your account profile. If the registrar rejects the registration after the charge, the payment is refunded.

Ruhusa ya Kuruhusiwa: domains:register (hutumwa na serikali:*)

Omba Vigezo vya Mwili

Penseli Aina Inahitajika Maelezo
domain string Ndiyo Kwa mfano, jina kamili la eneo hilo linatia ndani ukubwa wa jengo hilo.com
years integer Hapana Muda wa kujiandikisha, 1 hadi 10 (kwa tarehe 1) bei ni mara za kila mwaka..ai huhitaji angalau miaka 2, thamani ndogo zaidi kurudisha 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}'

Jibu la Mfano

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

Misimbo ya Hali ya Majibu

201 Domain alisajiliwa
400 Utawala wa zamani, wenye matumizi ambayo hayapatikani tena, bei haingethibitishwa, njia ya kulipa ya kikale, au malipo yakashindwa
402 Hakuna njia ya kulipa kwenye faili, au kwenye ovari zisizolipwa
500 The payment could not be processed, or the registrar rejected the registration after payment. In the second case the error message says whether the refund went through.
PENDEKEZO /api/v1/domains/{uuid}/renew/

Fanya Upya Kazi ya Kutengeneza Domain

Yapa habari upya utawala huo na kudai kwamba kila mwaka utatengeneza upya mapato yake kwa ajili ya njia yako ya kulipa.

Ruhusa ya Kuruhusiwa: domains:renew

Omba Vigezo vya Mwili

Penseli Aina Inahitajika Maelezo
years integer Hapana Miaka ya kuongezea, 1 hadi 10 (ajali 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)!"
}

Misimbo ya Hali ya Majibu

200 Domain alifanya upya
400 Miaka ya mapema, hakuna gharama yoyote ya matumizi ya serikali, njia ya malipo isiyo na kifani, au malipo yaliyoshindwa
404 Si wapatikanao, wala si wa Akaunti jingine
500 Malipo hayangeweza kulipiwa, au malipo yakapatikana lakini msajili huyo akashindwa kufanya upya kazi hiyo.
PUT /api/v1/domains/{uuid}/nameservers/

Watu Wanaohifadhi Jina Hivi Karibuni

Sets the domain's nameservers at the registrar and returns the updated domain object. To manage DNS with the DNS API, use ns1.vps.org, ns2.vps.org and ns3.vps.org and create a zone for the domain.

Ruhusa ya Kuruhusiwa: domains:update

Omba Vigezo vya Mwili

Penseli Aina Inahitajika Maelezo
nameserver1 string Ndiyo Jina la cheo
nameserver2, nameserver3, nameserver4 string Hapana Majina zaidi kwa ajili ya watu wanaojiita 
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"}'

Misimbo ya Hali ya Majibu

200 Jina la watu wanaohifadhi majina liliboreshwa; mwili ndio chombo cha matumizi
400 Majina - server1 yanakosekana
404 Si wapatikanao, wala si wa Akaunti jingine
500 Habari hizo zilishindwa kufanya kazi; mwili una kasoro na ujumbe mwingi
PUT /api/v1/domains/{uuid}/auto-renew/

Geuza au Urudine

Seti ya magari_rene mpya na kurudisha kitu cha serikali kilichotengenezwa kwa kisasa. Sensa hiyo iliwezesha kama uzi wowote usio na uchafu, ikiwa ni pamoja na uzi bandia, unageuka kuwa wa kiugari.

Ruhusa ya Kuruhusiwa: 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}'

Misimbo ya Hali ya Majibu

200 Mwili ndio kitu cha kutumiwa
400 Imewezesha kupotea
404 Si wapatikanao, wala si wa Akaunti jingine

Marejeo