VPS.org API

REST API ကိုစာရွက်စာတမ်းများ

ဒိုမိန်း API ကို

ရရှိနိုင် domain name များအတွက်ရှာဖွေ, မှတ်ပုံတင်ခြင်းနှင့် domain များကိုပြန်လည်ဆန်းသစ်, သူတို့ရဲ့ nameservers နှင့် auto-renew ကိုစီမံခန့်ခွဲ. domains များသူတို့ရဲ့ uuid အားဖြင့်အမည်စာရင်းတင်သွင်းကြသည်။

အဆုံးမှတ်များ 7
အခြေခံလမ်းကြောင်း /api/v1/domains
ရယူပါ /api/v1/domains/

ဒိုမိန်းအားလုံးကို စာရင်းပြုစုပါ

သင့်ရဲ့အကောင့်တွင်မှတ်ပုံတင်ထားသော domains များကိုပြန်ပေး, 25 စာမျက်နှာတစ်မျက်နှာ. စာရင်း filters များမရှိ.

ခွင့်ပြုချက်လိုအပ်သည်: domains:list

နမူနာတောင်းဆိုချက်

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

ဥပမာတုံ့ပြန်မှု

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

တုံ့ပြန်မှု ကွက်လပ်များ

နယ်မြေ အမျိုးအစား ဖော်ပြချက်
uuid string အခြား ဒိုမိန်းအဆုံးအဖြတ်များတွင်အသုံးပြုသော ဒိုမိန်းအမည်
status string active, pending, expired, cancelled, transferred
registrar string Registrar တွင်ကျင်းပသော domain ကို
registration_date, expiration_date datetime ထို domain ကိုမှတ်ပုံတင်ခဲ့သည်နှင့်အခါ၎င်းသည် expires. expiration_date null ဖြစ်နိုင်ပါသည်.
days_until_expiration integer | null expiration_date အထိနေ့ပေါင်းအားလုံး, negative တစ်ခါသက်တမ်းကုန်ဆုံး
is_expired, needs_renewal_soon boolean domain ကိုသက်တမ်းကုန်ဆုံးပြီဖြစ်စေ၊ နောက်ထပ် 30 ရက်အတွင်းသက်တမ်းကုန်ဆုံးမည်ဖြစ်စေ
auto_renew, renewal_period_years boolean, integer domain ကိုအလိုအလျောက်ပြန်လည်ဆန်းသစ်ဖြစ်စေ, နှင့်နှစ်ပေါင်းဘယ်လောက်အတွက်
registration_price, renewal_price string ဒသမ strings အဖြစ် USD တွင်စျေးနှုန်းများ
whois_privacy, transfer_lock boolean WHOIS လုံခြုံရေးနှင့်မှတ်ပုံတင်လွှဲပြောင်း lock ကို settings များကို
nameserver1 to nameserver4 string | null ဒိုမိန်း၏ နာမည်ဆာဗာများ
created_at, updated_at datetime မှတ်တမ်းကိုဖန်တီးပြီးနောက်ဆုံးပြောင်းလဲခဲ့သည် (ISO 8601, UTC)
ရယူပါ /api/v1/domains/{uuid}/

ဒိုမိန်းအသေးစိတ်အချက်အလက်များ

အပေါ်က Fields များနှင့်အတူတစ် domain object ကိုပြန်လာသည်။

ခွင့်ပြုချက်လိုအပ်သည်: domains:list

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

တုံ့ပြန်မှု အခြေအနေ ကုဒ်များ

200 အောင်မြင်မှု
404 မတွေ့ရှိပါ၊ သို့မဟုတ် အခြားအကောင့်တစ်ခုနှင့် သက်ဆိုင်သည်
ပို့စ် /api/v1/domains/search/

ရှာဖွေမှုဒေတာဘေ့စ

အကြောင်းကိုကျော်နာမည်တစ်ခုရရှိနိုင်ဖြစ်ပါသလားစစ်ဆေး 20 ခေတ်စား extensions (com, အင်တာနက်, org, io, dev, co, app, ai နှင့်ပိုပြီး), ၎င်းတို့အကြားမဟုတ်လျှင်သင်ရိုက်ထည့် extension ကိုပေါင်း. ရလဒ်များကိုတိကျတဲ့ပွဲစဉ်နှင့်အတူစတင်, ထို့နောက်ရရှိနိုင်အမည်များ, ထို့နောက်ယူသောသူတို့ကို.

ခွင့်ပြုချက်လိုအပ်သည်: domains:search

ခန္ဓာကိုယ် ကန့်သတ်ချက်များ တောင်းဆိုပါ

သတ်မှတ်ချက် အမျိုးအစား လိုအပ်သည် ဖော်ပြချက်
domain string ဟုတ်ကဲ့ ဥပမာအားဖြင့် mysite သို့မဟုတ် mysite.com (2 မှ 63 အက္ခရာများ) တစ်ခု extension ကိုနှင့်အတူသို့မဟုတ်မရှိဘဲအမည်တစ်ခု

နမူနာတောင်းဆိုချက်

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

ဥပမာတုံ့ပြန်မှု

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

ဈေးနှုန်းများတစ်နှစ်အဘို့အဒေါ်လာသန်းပေါင်းများစွာနှင့်ရရှိနိုင်မဟုတ်သောနာမကို null နေကြသည်. ဈေးနှုန်းများပြသပြသကြသည်။

တုံ့ပြန်မှု အခြေအနေ ကုဒ်များ

200 အောင်မြင်မှု
400 ရှာမတွေ့သော domain, သို့မဟုတ်စာလုံးများ, အရေအတွက်နှင့် hyphens ထက်အခြားအက္ခရာများပါဝင်သည်
500 မှတ်ပုံတင်ရှာဖွေမှု မအောင်မြင်ပါ၊ နောက်ပိုင်း ပြန်ကြိုးစားပါ
ပို့စ် /api/v1/domains/register/

ဒိုမိန်းအသစ် မှတ်ပုံတင်ပါ

domain ကိုမှတ်ပုံတင်ခြင်းနှင့်သင်၏သိမ်းဆည်းထားသောငွေပေးချေမှုနည်းလမ်းကို charges. ရရှိနိုင်မှုနှင့်စျေးနှုန်းကို charge ကိုမတိုင်မီပြန် register နှင့်အတူစစ်ဆေးကြသည်။ အဆိုပါ registrant ဆက်သွယ်ရေးအချက်အလက်များကိုသင်၏အကောင့် profile ကိုမှယူကြသည်။ register ပေးဆောင်ပြီးနောက်မှတ်ပုံတင်ငြင်းပယ်လျှင်, ပေးချေမှုပြန်ပေးချေသည်။

ခွင့်ပြုချက်လိုအပ်သည်: domains:register (domains များအားဖြင့်ပေးအပ်: *)

ခန္ဓာကိုယ် ကန့်သတ်ချက်များ တောင်းဆိုပါ

သတ်မှတ်ချက် အမျိုးအစား လိုအပ်သည် ဖော်ပြချက်
domain string ဟုတ်ကဲ့ ဥပမာ example.com အတွက်, ၎င်း၏ extension ကိုအပါအဝင်အပြည့်အဝ domain name ကို
years integer ဟုတ်ကဲ့ မှတ်ပုံတင်ကာလ, 1 မှ 10 (default 1). ဈေးနှုန်းနှစ်စဉ်စျေးနှုန်းနှစ်ကြိမ်နှစ်ဖြစ်ပါသည်..ai အနည်းဆုံးလိုအပ်2နှစ်; အသေးစားတန်ဖိုးကိုပြန်လာ 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}'

ဥပမာတုံ့ပြန်မှု

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

တုံ့ပြန်မှု အခြေအနေ ကုဒ်များ

201 ဒိုမိန်းမှတ်ပုံတင်
400 Invalid domain, domain ကိုမရရှိနိုင်, ဈေးနှုန်းကိုစစ်ဆေးနိုင်ခဲ့သည်မဟုတ်, ခေတ်မီငွေပေးချေမှုနည်းလမ်း, သို့မဟုတ်ငွေပေးချေမှုပျက်ကွက်
402 ဖိုင်ပေါ်တွင်ငွေပေးချေမှုနည်းလမ်းမရှိ၊ သို့မဟုတ်မပေးချေသောငွေစာရင်း
500 ငွေပေးချေမှုမပြုနိုင်ခဲ့, သို့မဟုတ်အမည်စာရင်းပေးသွင်းသူပေးချေပြီးနောက်မှတ်ပုံတင်ခြင်းငြင်းပယ်. ဒုတိယဖြစ်ရပ်တွင်အမှားသတင်းစကားကပြန်အမ်းငွေမှတဆင့်သွားခဲ့သည်မဟုတ်ပါဆိုသည်။
ပို့စ် /api/v1/domains/{uuid}/renew/

ဒိုမိန်းတစ်ခုကို ပြန်လည်ပြင်ဆင်ပါ

Renew the domain and charges its renewal_price for each year to your saved payment method.

ခွင့်ပြုချက်လိုအပ်သည်: domains:renew

ခန္ဓာကိုယ် ကန့်သတ်ချက်များ တောင်းဆိုပါ

သတ်မှတ်ချက် အမျိုးအစား လိုအပ်သည် ဖော်ပြချက်
years integer ဟုတ်ကဲ့ နှစ်ပေါင်းပေါင်းထည့်ရန်, 1 မှ 10 (စံ 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)!"
}

တုံ့ပြန်မှု အခြေအနေ ကုဒ်များ

200 ဒိုမိန်းအသစ်
400 မမှန်ကန်တဲ့နှစ်များ, domain ကိုများအတွက်မ Renewal ဈေးနှုန်း, မအသုံးပြုနိုင်သောငွေပေးချေမှုနည်းလမ်း, သို့မဟုတ်ငွေပေးချေမှုပျက်ကွက်
404 မတွေ့ရှိပါ၊ သို့မဟုတ် အခြားအကောင့်တစ်ခုနှင့် သက်ဆိုင်သည်
500 ငွေပေးချေမှုမပြုပြင်နိုင်ခဲ့, သို့မဟုတ်ငွေပေးချေမှုကနေသွားခဲ့ပေမယ့် registrar ပြန်လည်ဆန်းသစ်မအောင်မြင်. ထိုကိစ္စတွင်တွင်ထောက်ခံမှု Contact.
PUT /api/v1/domains/{uuid}/nameservers/

နာမည် ဆာဗာများ

DNS API ကိုနှင့်အတူ DNS ကိုစီမံခန့်ခွဲရန်, ns1.vps.org ကိုအသုံးပြု, ns2.vps.org နှင့် ns3.vps.org နှင့်ဒေသအတွက် zone ကိုဖန်တီး.

ခွင့်ပြုချက်လိုအပ်သည်: domains:update

ခန္ဓာကိုယ် ကန့်သတ်ချက်များ တောင်းဆိုပါ

သတ်မှတ်ချက် အမျိုးအစား လိုအပ်သည် ဖော်ပြချက်
nameserver1 string ဟုတ်ကဲ့ အဓိက နာမည် ဆာဗာ အမည်
nameserver2, nameserver3, nameserver4 string ဟုတ်ကဲ့ အခြားနာမည်ဆာဗာများ 
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"}'

တုံ့ပြန်မှု အခြေအနေ ကုဒ်များ

200 နာမည်ဆာဗာများအသစ်; အတွင်းပိုင်းသည် domain object ကိုဖြစ်ပါသည်
400 nameserver1 မတွေ့ပါ
404 မတွေ့ရှိပါ၊ သို့မဟုတ် အခြားအကောင့်တစ်ခုနှင့် သက်ဆိုင်သည်
500 ပြုပြင်ခြင်း မအောင်မြင်ပါ၊ အတွင်းပိုင်းမှာ အမှားနဲ့ အကြောင်းကြားချက် နယ်ပယ်များရှိပါသည်
PUT /api/v1/domains/{uuid}/auto-renew/

အလိုအလျောက် ပြန်လည်ပြင်ဆင်ခြင်းကို ဖွင့်/ပိတ်ပါ

auto_renew သတ်မှတ်ပြီးအသစ်က domain object ကိုပြန်လာ။ ပို့ JSON boolean အဖြစ် activated: မည်သည့်အတင်းအကျပ်မ-အလွတ် string ကို, အဆိုပါ string ကိုမှားယွင်းအပါအဝင်, auto-renew အပေါ် turns.

ခွင့်ပြုချက်လိုအပ်သည်: 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}'

တုံ့ပြန်မှု အခြေအနေ ကုဒ်များ

200 သတ်မှတ်ချက် သိမ်းဆည်းပြီး၊ အတွင်းပိုင်းသည် ဒိုမိန်း အရာဝတ္ထုဖြစ်သည်
400 ခွင့်ပြုထားပြီး မပါ
404 မတွေ့ရှိပါ၊ သို့မဟုတ် အခြားအကောင့်တစ်ခုနှင့် သက်ဆိုင်သည်

မှတ်စုများ