VPS.org API

Dọkumenti

Domeenụ̀ API

Chọ̀ọ́ maka aha ndóùmù dị̀ n'okpuru, rụọ ọrụ na ndóùmù ndị ọzọ, nakwa hazie ahasaráị̀fọdụ ha nakwa n'ótù-n'ótù. Dóùmù ndị ahụ akọwapụtara site na uuid ha.

Isi njedebe 7
Ụzọ Ntọala /api/v1/domains
Nweta /api/v1/domains/

Depụta ngalaba niile

Na-eziga ndòmịnị ndị a rụrụ ọrụ na akaụntụ gị, 25 n'ihuakwụkwọ ọ bụla. Ndesịta ahụ enweghị filtri.

Ikikere achọrọ: domains:list

Arịrịọ Ihe Nlereanya

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

Ihe Nlereanya Azịza

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

Ubi Nzaghachi

_Òkè Ụdị Ndesịta ozi ndị ahụ
uuid string Domain identifier used in the other domain endpoints
status string active, pending, expired, cancelled, transferred
registrar string Nhazi nke dòmịn ahụ na-echekwa na
registration_date, expiration_date datetime Mgbe a rịọrọ doomeinụ na mgbe ọ ga-agwụ. ụbọchị_agwụcha nwere ike ịbụ null.
days_until_expiration integer | null Ụbọchị niile ruo mgbe oge mmechi_ụbọchị, nke na-adịghị mma mgbe oge mmechi gachara
is_expired, needs_renewal_soon boolean Ma ọ bụ na domeenụ̀ ahụ echeghị oge, ma ọ bụ na ọ cheghị oge n'ime ụbọchị 30 na-esonụ
auto_renew, renewal_period_years boolean, integer Ma ọ bụ na ndomainụ ahụ na-akpụgharị n'onwe ya, na maka afọ ole na ole
registration_price, renewal_price string Nhazi na USD dịka ndezi strings
whois_privacy, transfer_lock boolean Nhazi nchebe WHOIS nakwa ntọala nkwụsị n'ịgbanwe onyenhọrọ
nameserver1 to nameserver4 string | null Nameservers nke dòmịn ahụ
created_at, updated_at datetime Mgbe a haziri réèfọ́ọ̀ltụ̀ ahụ ma gbanwee ya n'oge ikpeazụ (ISO 8601, UTC)
Nweta /api/v1/domains/{uuid}/

Nkọwapụta _Domain

Na-eziga otu domino ihenhọrọ na mpaghara ebe ndị ahụ n'elu.

Ikikere achọrọ: domains:list

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

Koodu Ọnọdụ Nzaghachi

200 Ńkwádò
404 Agaghị achọpụtara ya, mọọbụ ọ bụ nke ọzọ akaụntụ
ANYỊ /api/v1/domains/search/

Chọ̀ọ́ n'ihe oghé

Nnyocha ma ọ bụrụ na aha dị n'elu 20 nke n'ahụkarị n'imewe (com, net, org, io, dev, co, app, ai na ndị ọzọ), nakwa n'imewe ị tinyere ma ọ bụrụ na ọ bụghị n'ime ha. Ọrụ na-amalite na n'ozuzu ya, mgbe ahụ aha dịnụ, mgbe ahụ ndị a na-ewere.

Ikikere achọrọ: domains:search

Rịọ maka paramita ahụ

Paramita Ụdị A chọrọ Ndesịta ozi ndị ahụ
domain string Ee Aha na mọọbụ na-enweghị ngwụcha, dịka ọmụmaatụ mysite mọọbụ mysite.com (2 ruo 63 akara)

Arịrịọ Ihe Nlereanya

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

Ihe Nlereanya Azịza

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

Nhazi ndị ahụ bụ nọmba na USD maka afọ otu na ọ bụ null maka aha ndị ahụ enweghị ike. Nhazi ndị ahụ egosipụtara bụ nke ngosipụta.

Koodu Ọnọdụ Nzaghachi

200 Ńkwádò
400 Domeenụ̀ na-efu, mọọbụ ọ na-echekwa akara n'ebe ọbụla n'ebe ọbụla n'ebe ọbụla
500 Nlegharị rị́ègì ahụ énweghị ike. Pịa ọzọ mgbe ahụ.
ANYỊ /api/v1/domains/register/

Debanye aha ngalaba ọhụrụ

Rékètárádòmị̀ ná akwụ́ ụgwọ ụzọ ịkwụ ụgwọ gị. A na-enyocha ike ná ọnụahịa ná onye nrụpụta n'ihu. A na-ewepụ nkọwa nke onye nrụpụta n'ime profaịlụ akaụntụ gị. Ọ bụrụ na onye nrụpụta achọghị ịbanye mgbe a na-akwụ ụgwọ, a ga-akwụghachi ụgwọ ahụ.

Ikikere achọrọ: domains:register (ekwenyere site na ndomains:*)

Rịọ maka paramita ahụ

Paramita Ụdị A chọrọ Ndesịta ozi ndị ahụ
domain string Ee Aha doomeinụ zuru ezu gụnyere n'ụdị nke ya, dịka ọmụmaatụ example.com
years integer Ọ bụghị Oge ndebanye, 1 ruo 10 (dìfọ́ọ̀ltụ̀ 1). Nkwado bụ oge nkwado afọ..ai chọrọ ọbụla afọ 2; uru obere na-eziga 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}'

Ihe Nlereanya Azịza

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

Koodu Ọnọdụ Nzaghachi

201 Ndesịta adreesị
400 Domeesị a na-ekwenyeghị, domeesị a na-enweghị ike, ọnụahịa ahụ agaghị ekwe omume ịhụ na ọ bụ eziokwu, ụzọ nkwụghachi ahụ agwụla ma ọ bụ nkwụghachi ahụ ewepụtala
402 Enweghị ụzọ nkwụ ụgwọ na faịlụ, mọọbụ inweta ndị a na-akwụghị ụgwọ
500 Agaghị arụzigharịrị ụgwọ ahụ, mọọbụ onye nrụpụta hapụla ndebanye mgbe ụgwọ ahụ gasịrị. N'ihe a na-eme n'oge nke abụọ, ozi ndehie ahụ na-ekwu ma ọ bụrụ na ego ahụ gafere.
ANYỊ /api/v1/domains/{uuid}/renew/

Wepụ ndoaịkọn

Na-emegharị ndomainị ahụ ma na-eburu renewal_price ya maka afọ ọbụla n'ụzọ ịkwụ ụgwọ gị echekwara.

Ikikere achọrọ: domains:renew

Rịọ maka paramita ahụ

Paramita Ụdị A chọrọ Ndesịta ozi ndị ahụ
years integer Ọ bụghị Ụbọchị iji tinye, 1 ruo 10 (dìfọ́ọ̀ltụ̀ 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)!"
}

Koodu Ọnọdụ Nzaghachi

200 Domeesị agbakwunyere
400 Ụbọchị ndị ahụ abụghị nke ziri ezi, enweghị uru n'ụdị mmegharị maka ndomain, enweghị ụzọ nkwụghachi na-eji ya, mọọbụ nkwụghachi ahụ ehichapụla
404 Agaghị achọpụtara ya, mọọbụ ọ bụ nke ọzọ akaụntụ
500 Enweghị ike ijikwa ụgwọ, mọọbụ ụgwọ ahụ gafere ma ọ bụ ọbụla n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime ma ọ bụ n'ime. Kpọtụrụ nkwado na ọnọdụ ahụ.
PUT /api/v1/domains/{uuid}/nameservers/

Nhazi

Na-ehazi ahasaraịlụ ndoumene na registrar na-eziga ozíọ̀gụ̀ ndoumene agbakwunyere. Ka i jiri DNS na DNS API, jiri ns1.vps.org, ns2.vps.org na ns3.vps.org ma mepụta mpaghara ebee maka ndoumene ahụ.

Ikikere achọrọ: domains:update

Rịọ maka paramita ahụ

Paramita Ụdị A chọrọ Ndesịta ozi ndị ahụ
nameserver1 string Ee Aha ónyénwē nameserver mbụ
nameserver2, nameserver3, nameserver4 string Ọ bụghị Aha ndịna ndị ọzọ
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"}'

Koodu Ọnọdụ Nzaghachi

200 Ndesịta ozi ndị ahụ emegharịrịla; ọbụna ọbụna bụ ọbjektị dòmịn
400 nameserver1 ehichapụ
404 Agaghị achọpụtara ya, mọọbụ ọ bụ nke ọzọ akaụntụ
500 Nhazigharị ahụ ehichapụla; ọbụna
PUT /api/v1/domains/{uuid}/auto-renew/

Kwụsị mmelite nkeonwe mọọbụ kwụsị ya

Na-ehazi auto_renew ma weghachi ndòmị ọbjektị agbakwunyere. Ziga dị ka JSON boolean: ọbụla ọbụla string nke abụghị nke mebiri emebi, gụnyere string nke ụgha, na-emegharị auto-renew.

Ikikere achọrọ: 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}'

Koodu Ọnọdụ Nzaghachi

200 Nhazi achekwaala; ọbụna ọbụna bụ ọbjektị dòmịn
400 Enweghị ike ijikwa
404 Agaghị achọpụtara ya, mọọbụ ọ bụ nke ọzọ akaụntụ

Ntụziaka