VPS.org API

REST API Documentation

Ma domains API

Pezani dzina la domain lomwe lilipo, lolembetsa ndi losintha domains, ndi kuyendetsa ma servers awo a dzina ndi kusinthidwa kwaokha.

Mapeto 7
Njira Yoyambira /api/v1/domains
Pezani /api/v1/domains/

Lembani Ma Domeni Onse

Kubwerera ma domains analembetsa mu akaunti yanu, 25 patsamba. mnda alibe zosapanga dzimbiri.

Kufunikira kwa ufulu: domains:list

Chitsanzo cha Pempho

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

Chitsanzo cha Yankho

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

Mayankho a Minda

Kuwala Mtundu Kufotokozera
uuid string Kuzindikira kwa domenu kumagwiritsidwa ntchito m'maziko ena a domenu
status string active, pending, expired, cancelled, transferred
registrar string Registrar domene ndi yokhala pa
registration_date, expiration_date datetime Pamene domain analembetsa ndi pamene amapita. expiration_date angakhale null.
days_until_expiration integer | null Masiku onse mpaka expiration_date, woipa pamene apita
is_expired, needs_renewal_soon boolean Ngati domain yatha, ndipo ngati idzatha m'masiku 30 otsatira
auto_renew, renewal_period_years boolean, integer Ngati domain imasinthidwa mwamsanga, ndi kwa zaka zingati
registration_price, renewal_price string Mitengo mu USD monga decimal strings
whois_privacy, transfer_lock boolean WHOIS kuteteza ufulu ndi registrar kutengerapo lock zosankha
nameserver1 to nameserver4 string | null Nameservers ya domain
created_at, updated_at datetime Nthawi yomwe ndondomekoyo inapangidwa ndi kusinthidwa (ISO 8601, UTC)
Pezani /api/v1/domains/{uuid}/

Pezani Domain Deta

Kubwerera imodzi domain chinthu ndi nyanja pamwambapa.

Kufunikira kwa ufulu: domains:list

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

Makhodi a Mkhalidwe Woyankha

200 Kupambana
404 Siyipezeka, kapena ili ndi akaunti ina
POST /api/v1/domains/search/

Pezani Domain Kupezeka

Kuyesa ngati dzina lilipo m'masamba otchuka pafupifupi 20 (com, net, org, io, dev, co, app, ai ndi ena), ndi kuwonjezera pa tsamba lowonjezera lomwe mwalemba ngati silo pakati pawo. Mayankho amayamba ndi kugwirizana koyenera, kenako dzina lopezeka, kenako omwe adaperekedwa.

Kufunikira kwa ufulu: domains:search

Pemphani Ma Parameter a Thupi

Paramita Mtundu Zofunika Kufotokozera
domain string Inde dzina ndi kapena popanda kuwonjezeka, monga mysite kapena mysite.com (2 mpaka 63 zilembo)

Chitsanzo cha Pempho

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

Chitsanzo cha Yankho

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

Mamitengo ndi mayunitsi a USD kwa chaka chimodzi ndipo ndi null kwa dzina lomwe silipezeka. Mamitengo omwe akuwonetsedwa ndi ofotokozera.

Makhodi a Mkhalidwe Woyankha

200 Kupambana
400 Kukayika domain, kapena ili ndi maonekedwe ena kuposa malemba, zigawo ndi hyphens
500 Kufuna kwa registrar kunalephera.
POST /api/v1/domains/register/

Lembetsani Domain Yatsopano

Kulembetsa domain ndi kulipira njira yanu yosungira ndalama. Kupezeka ndi mtengo zimayesedwanso ndi woyang'anira pambuyo pa kulipira. Zomwe zimakhudza woyang'anira zimachokera pa akaunti yanu. Ngati woyang'anira amakana kulembetsa pambuyo polipira, ndalama zimabwezedwa.

Kufunikira kwa ufulu: domains:register (kuperekedwa ndi ma domains: *)

Pemphani Ma Parameter a Thupi

Paramita Mtundu Zofunika Kufotokozera
domain string Inde dzina la domain lonse kuphatikizapo kuwonjezera, monga example.com
years integer Si Kulembetsa nthawi, 1 kuti 10 (default 1). mtengo ndi chaka chatha mtengo nthawi zaka..ai amafuna nthawi yochepa 2 zaka; mtengo waukulu amabwerera 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}'

Chitsanzo cha Yankho

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

Makhodi a Mkhalidwe Woyankha

201 Domain yolembetsedwa
400 Kulephera kwa domain, domain siyipezekanso, mtengo siyitha kutsimikiziridwa, njira yolipira yosasinthika, kapena kulipira kulephera
402 Simunasankhe njira yolipira kapena simunalandire ndalama
500 Kulipira sikunathe kuchitidwa, kapena woyang'anira adakana kulembetsa pambuyo pa kulipira.Mu kafukufuku wachiwiri, uthenga wa vuto umafotokoza ngati kubwezeredwa kunachitika.
POST /api/v1/domains/{uuid}/renew/

Kusintha kwa Domain

Amasintha dzina la domain ndipo amalipira renewal_price yake chaka chilichonse pogwiritsa ntchito njira yolipira yomwe mwasunga.

Kufunikira kwa ufulu: domains:renew

Pemphani Ma Parameter a Thupi

Paramita Mtundu Zofunika Kufotokozera
years integer Si Miyezi yowonjezera, 1 mpaka 10 (zosasinthika 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)!"
}

Makhodi a Mkhalidwe Woyankha

200 Domain anasintha
400 Masiku osavomerezeka, palibe mtengo wobwezeretsa kwa domain, palibe njira yolipira yogwiritsira ntchito, kapena ndalama zidalephera
404 Siyipezeka, kapena ili ndi akaunti ina
500 Malipiro sanathe kuchitidwa, kapena malipiro anapita mwamsanga koma woyang'anira kubwezeretsa analephera. Contact support in that case.
PUT /api/v1/domains/{uuid}/nameservers/

Kusintha kwa Nameservers

Kuti muyang'ane DNS ndi DNS API, kugwiritsa ntchito ns1.vps.org, ns2.vps.org ndi ns3.vps.org ndi kupanga malo a nyanja kwa domain.

Kufunikira kwa ufulu: domains:update

Pemphani Ma Parameter a Thupi

Paramita Mtundu Zofunika Kufotokozera
nameserver1 string Inde Primary nameserver hostname
nameserver2, nameserver3, nameserver4 string Si Ma server ena a dzina 
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"}'

Makhodi a Mkhalidwe Woyankha

200 Nameservers updated; the body is the domain object
400 Nameserver1 sapezeka
404 Siyipezeka, kapena ili ndi akaunti ina
500 Kusinthaku kunalephera; thupi lili ndi zolakwika ndi masamba a ujumbe
PUT /api/v1/domains/{uuid}/auto-renew/

Kusintha kwa Auto-Renew pa kapena Off

Ikhazikitsa auto_renew ndi kutumiza mfundo ya domain yosinthidwa. Kutumiza kupezeka ngati JSON boolean: chilichonse chosatha, kuphatikizapo mfundo yosavomerezeka, chimayambitsa kusinthidwa kokha.

Kufunikira kwa ufulu: 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}'

Makhodi a Mkhalidwe Woyankha

200 Setting saved; the body is the domain object
400 enabled missing
404 Siyipezeka, kapena ili ndi akaunti ina

Zikumbutso