VPS.org API

REST API ලේඛන

ඩොමේන API

ලබා ගත හැකි ඩොමේන් නාම සඳහා සෙවුම්, ලියාපදිංචි හා ඩොමේන් අලුත් කිරීම, සහ ඔවුන්ගේ නාම සේවාදායක සහ ස්වයංක්රීය අලුත් කිරීම කළමනාකරණය. ඩොමේන් ඔවුන්ගේ uuid විසින් හඳුනාගෙන ඇත.

අන්ත ලක්ෂ්‍ය 7
පාදක මාර්ගය /api/v1/domains
ලබා ගන්න /api/v1/domains/

සියලුම වසම් ලැයිස්තුගත කරන්න

ඔබේ ගිණුම ලියාපදිංචි ඩොමේන ආපසු, 25 පිටුවකට. ලැයිස්තුව පෙරහන් නැත.

අවසර අවශ්‍යයි: 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 ඩොමේන් රෙජිස්ටාර් දී පැවැත්වේ
registration_date, expiration_date datetime ඩොමේන් ලියාපදිංචි කරන ලදී විට හා එය කල් ඉකුත් වන විට. expiration_date ශුන්‍ය විය හැක.
days_until_expiration integer | null expiration_date දක්වා සම්පූර්ණ දින, කල් ඉකුත් වූ විට ඍණ
is_expired, needs_renewal_soon boolean ඩොමේන් කල් ඉකුත් වී ඇති අතර, එය ඊළඟ දින 30 තුළ කල් ඉකුත් වේ නම්
auto_renew, renewal_period_years boolean, integer ඩොමේනය ස්වයංක්රීයව අලුත් කරන අතර, වසර කීයක් සඳහාද
registration_price, renewal_price string දශම strings ලෙස USD මිල ගණන්
whois_privacy, transfer_lock boolean WHOIS පෞද්ගලිකත්වය සහ ලියාපදිංචි මාරු අගුළු සැකසුම්
nameserver1 to nameserver4 string | null වසමෙහි නාම සේවාදායක
created_at, updated_at datetime වාර්තාව නිර්මාණය කරන ලද්දේ සහ අවසන් වරට වෙනස් කරන ලද්දේ (ISO 8601, UTC)
ලබා ගන්න /api/v1/domains/{uuid}/

ඩොමේන් විස්තර ලබාගන්න

ඉහත ක්ෂේත්ර සමග එක් ඩොමේන් වස්තුව ආපසු.

අවසර අවශ්‍යයි: 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 ජනප්රිය දිගු (com, ශුද්ධ, org, io, dev, co, app, ai සහ තවත්), එය ඔවුන් අතර නොවේ නම් ඔබ ටයිප් ප්ලස් දිගුව. ප්රතිඵල නිවැරදි ගැලපීම සමඟ ආරම්භ, පසුව ලබා ගත හැකි නම්, පසුව ගත් අය.

අවසර අවශ්‍යයි: domains:search

ඉල්ලීම් ශරීර පරාමිතීන්

පරාමිතීන් වර්ගය අවශ්‍යයි විස්තරය
domain string ඔව් දිගුව සමග හෝ නොමැතිව නාමය, උදාහරණයක් ලෙස mysite හෝ mysite.com (2 සිට 63 අක්ෂර)

උදාහරණ ඉල්ලීම

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
}

මිල ගණන් එක් වසරක් සඳහා ඇමරිකානු ඩොලර් සංඛ්යාවන් වන අතර, ලබා ගත නොහැකි නම් සඳහා ශුන්ය වේ. පෙන්වා මිල ගණන් උදාහරණයක් වේ.

ප්‍රතිචාර තත්ව කේත

200 සාර්ථකත්වය
400 ඩොමේනය අතුරුදහන් වී ඇත, හෝ එය අකුරු, අංක සහ හයිෆන් වලට අමතරව අකුරු අඩංගු වේ
500 ලියාපදිංචිය සෙවීම අසාර්ථකයි. පසුව උත්සාහ කරන්න.
තැපැල් /api/v1/domains/register/

නව වසමක් ලියාපදිංචි කරන්න

ඩොමේන් නාමයක් ලියාපදිංචි කිරීම සහ ඔබේ සුරකින ලද ගෙවීම් ක්රමයක් අය කිරීම. ගාස්තු අය කිරීමට පෙර නැවත ලියාපදිංචිකරු සමඟ ලබා ගත හැකි සහ මිල පරීක්ෂා කරනු ලැබේ. ලියාපදිංචිකරු සම්බන්ධතා විස්තර ඔබේ ගිණුම පැතිකඩ සිට ගෙන ඇත. ගාස්තු අය කිරීමෙන් පසු ලියාපදිංචිකරු ලියාපදිංචිය ප්රතික්ෂේප කරන්නේ නම්, ගෙවීම් ආපසු ගෙවනු ලැබේ.

අවසර අවශ්‍යයි: domains:register (ඩොමේන් විසින් ලබා දී ඇත:*)

ඉල්ලීම් ශරීර පරාමිතීන්

පරාමිතීන් වර්ගය අවශ්‍යයි විස්තරය
domain string ඔව් එහි දිගුව ඇතුළු සම්පූර්ණ ඩොමේන් නාමය, උදාහරණයක් ලෙස example.com
years integer නෑ ලියාපදිංචි කාලය, 1 සිට 10 (පෙරනිමි 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 වලංගු ඩොමේන්, ඩොමේන් තවදුරටත් ලබා ගත නොහැකි, මිල තහවුරු කළ නොහැකි, පැරණි ගෙවීම් ක්රමයක්, හෝ ගෙවීම් අසාර්ථක
402 ගොනුව මත ගෙවීම් ක්රමයක් නැත, හෝ ගෙවීම් නොකළ ඉන්වොයිසි
500 ගෙවීම ක්රියාත්මක කළ නොහැකි විය, හෝ ලියාපදිංචිකරු ගෙවීමෙන් පසු ලියාපදිංචිය ප්රතික්ෂේප කළේය. දෙවන අවස්ථාවේ දී දෝෂ පණිවිඩය ආපසු ගෙවීම සිදු වූවාද යන්න පවසයි.
තැපැල් /api/v1/domains/{uuid}/renew/

ඩොමේනයක් අලුත් කරන්න

ඩොමේන් අලුත්වැඩියා සහ ඔබේ සුරකින ලද ගෙවීම් ක්රමයට එක් එක් වසර සඳහා එහි renewal_price අය.

අවසර අවශ්‍යයි: 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 අවලංගු වසර, ඩොමේන් සඳහා නවීකරණය මිල, භාවිතා කළ හැකි ගෙවීම් ක්රමයක් නැත, හෝ ගෙවීම් අසාර්ථක
404 හමු නොවිනි, හෝ එය වෙනත් ගිණුමක් සතුව ඇත
500 ගෙවීම් ක්රියාත්මක කළ නොහැකි විය, හෝ ගෙවීම් හරහා ගිය නමුත් ලියාපදිංචි නවීකරණය අසාර්ථක. එම අවස්ථාවේ දී සහාය සම්බන්ධ කර ගන්න.
PUT /api/v1/domains/{uuid}/nameservers/

නාම සේවාදායක යාවත්කාලීන කරන්න

ඩීඑන්ඒ API සමඟ ඩීඑන්ඒ කළමනාකරණය කිරීමට, ns1.vps.org, ns2.vps.org හා ns3.vps.org භාවිතා සහ ඩොමේන් සඳහා කලාපයක් නිර්මාණය.

අවසර අවශ්‍යයි: 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 නම සේවාදායක යාවත්කාලීන; ශරීරය ඩොමේන් වස්තුවයි
400 nameserver1 නොමැත
404 හමු නොවිනි, හෝ එය වෙනත් ගිණුමක් සතුව ඇත
500 යාවත්කාලීන කිරීම අසාර්ථකයි; ශරීරයට දෝෂ සහ පණිවිඩ ක්ෂේත්‍ර ඇත
PUT /api/v1/domains/{uuid}/auto-renew/

ස්වයංක්‍රීය අලුත් කිරීම සක්‍රීය හෝ අක්‍රීය කරන්න

auto_renew සකස් හා යාවත්කාලීන ඩොමේන් වස්තුව ආපසු. JSON බූලියන් ලෙස සක්‍රීය යැවීම: වංචාව string ඇතුළු ඕනෑම හිස් නොවන string, මත ස්වයංක්රීය අලුත්වැඩියා හරවයි.

අවසර අවශ්‍යයි: 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 හමු නොවිනි, හෝ එය වෙනත් ගිණුමක් සතුව ඇත

සටහන්