VPS.org API

REST API Documentation

Mazita ezita

Kutsvaga mazita edomains anowanikwa, kurodha uye kudzokorora madomains, uye kuchengetedza maservers avo ezita uye otomatiki kudzokorora. Madomains anozivikanwa neuuid yavo.

Magumo 7
Nzira Yekutanga /api/v1/domains
Tora /api/v1/domains/

Nyora Madhomini Ese

Retourne les domaines enregistrés dans votre compte, 25 par page. La liste n'a pas de filtres.

Kuda mvumo: domains:list

Muenzaniso weChikumbiro

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

Muenzaniso weMhinduro

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

Minda Yemhinduro

_Firi Rudzi Kutaura
uuid string Domain identifier used in the other domain endpoints
status string active, pending, expired, cancelled, transferred
registrar string Domain inochengetwa neRegistrar
registration_date, expiration_date datetime Kana domain yakanga yanyorwa uye kana ichi expires. expiration_date anogona kunge null.
days_until_expiration integer | null Mazuva ese kusvika expiration_ date, negative kana yapera
is_expired, needs_renewal_soon boolean Kana domain yapfuura nguva yayo, uye kana ichisvika nguva yayo mumazuva 30 anotevera
auto_renew, renewal_period_years boolean, integer Kana domain inovandudzwa otomatiki, uye kuti inogara kwenguva yakareba sei
registration_price, renewal_price string Mitengo muUSD sezvinyorwa zvedecimal
whois_privacy, transfer_lock boolean WHOIS Privacy uye Registrar Transfer Lock settings
nameserver1 to nameserver4 string | null Nameservers yedomain
created_at, updated_at datetime Panguva iyo rekodhi yakagadzirwa uye yachinja (ISO 8601, UTC)
Tora /api/v1/domains/{uuid}/

Get Domain Details

Returns imwe domain chinhu nenzvimbo pamusoro.

Kuda mvumo: domains:list

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

Makodhi eMamiriro eMhinduro

200 Kubudirira
404 Haichawanikwa, kana kuti inobva kune imwe account
POST /api/v1/domains/search/

Search Domain Kuwanikwa

Checks whether a name is available across about 20 popular extensions (com, net, org, io, dev, co, app, ai and more), plus the extension you typed if it is not among them. Results start with the exact match, then available names, then taken ones.

Kuda mvumo: domains:search

Kumbira Maparamita Emuviri

Parameter Rudzi Zvinodiwa Kutaura
domain string Ehe A zita ne kana pasina kusvikira, semuenzaniso mysite kana mysite.com (2 kusvika 63 mavara)

Muenzaniso weChikumbiro

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

Muenzaniso weMhinduro

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

Mitengo inoratidza mari muUSD yegore rimwe chete uye haina kukwana kana zita rezita risina kuwanikwa. Mitengo inoratidza chete muenzaniso.

Makodhi eMamiriro eMhinduro

200 Kubudirira
400 Kukanganisa domain, kana kuti ine mavara kunze kwemazita, nhamba uye hyphens
500 Kutsvaga kweRegistrar kwakakundikana. Tarisazve mushure menguva.
POST /api/v1/domains/register/

Nyorera Domain Itsva

Kuwana uye mutengo unoongororwa neRegistrarzvezve pamberi pekubhadharisa. Mushandisi anosangana neruzivo rwekubatanidza rwemushandisi anotora kubva kuprofile yako yeaccount. Kana mushandisi akabvuma kubhadharisa, mari inobhadharwazve. Kana mushandisi akabvuma kubhadharisa, mari inobhadharwazve. Kana mushandisi akabvuma kubhadharisa, mari inobhadharwazve.

Kuda mvumo: domains:register (inopihwa nedomains:*)

Kumbira Maparamita Emuviri

Parameter Rudzi Zvinodiwa Kutaura
domain string Ehe Mufananidzo wezita redomain, kusanganisira zita redomain, semuenzaniso example.com
years integer Hapana Kugadzwa kwenguva, 1 kusvika 10 (default 1). The price is the yegore mutengo nguva makore..ai zvinoda 2 makore; 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}'

Muenzaniso weMhinduro

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

Makodhi eMamiriro eMhinduro

201 Domain registered
400 Domain isina kunaka, domain haina kuwanikwa, mutengo haugone kuongororwa, nzira yekubhadhara yapfuura, kana kubhadharwa kwakakundikana
402 Hapana nzira yekubhadhara yakanyorwa, kana invoices dzisina kubhadharwa
500 Kubhadhara kwaive kusingagone kugadziriswa, kana kuti mumiri akabvuma kunyoresa mushure mekubhadhara. Mumwe muenzaniso weichi chiitiko ndechekuti meseji yematambudziko inoti kana mari yadzoserwa yaendeswa.
POST /api/v1/domains/{uuid}/renew/

Kudzoreredza Domain

Inogadzirisa domain uye inobhadharisa iyo renewal_price yese gore neyako yakachengetwa nzira yekubhadhara.

Kuda mvumo: domains:renew

Kumbira Maparamita Emuviri

Parameter Rudzi Zvinodiwa Kutaura
years integer Hapana Mazuva ekuwedzera, 1 kusvika 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)!"
}

Makodhi eMamiriro eMhinduro

200 Domain rinovandudzwa
400 Makore asina kunaka, hapana mutengo wekudzokorora wedomain, hapana nzira yekubhadharisa inogona kushandiswa, kana kuti kubhadharisa kwakakundikana
404 Haichawanikwa, kana kuti inobva kune imwe account
500 Kubhadhara kwainge kusingagone kugadziriswa, kana kuti kubhadharwa kwainge kwaenda kuburikidza asi kuvandudzwa kwemumiri kwakakundikana.
PUT /api/v1/domains/{uuid}/nameservers/

Kugadzirisa

Kuti uite DNS neDNS API, shandisa ns1.vps.org, ns2.vps.org uye ns3.vps.org uye uite nzvimbo yedomain.

Kuda mvumo: domains:update

Kumbira Maparamita Emuviri

Parameter Rudzi Zvinodiwa Kutaura
nameserver1 string Ehe Primary nameserver hostname
nameserver2, nameserver3, nameserver4 string Hapana Nameservers 
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"}'

Makodhi eMamiriro eMhinduro

200 Nameservers updated; the body is the domain object
400 nameserver1 isiripo
404 Haichawanikwa, kana kuti inobva kune imwe account
500 Kugadziridza kwakakundikana; muviri une matambudziko uye meseji mabhokisi
PUT /api/v1/domains/{uuid}/auto-renew/

Kutanga kana kudzima otomatiki kutsvaira

Kutumira kunogona kunge kuri JSON boolean: chero mashoko aripo, kusanganisira mashoko aripo ari falso, anovhura kudzokorora otomatiki.

Kuda mvumo: 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}'

Makodhi eMamiriro eMhinduro

200 Kugadzirisa kwakachengetwa; muviri ndewe domain object
400 enabled missing
404 Haichawanikwa, kana kuti inobva kune imwe account

Nhoroondo