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 களம் பதிவு செய்யப்பட்டபோது மற்றும் அது காலாவதியாகும் போது. காலாவதி_ தேதி என்பது புளூடூத் ஆக இருக்கலாம்.
days_until_expiration integer | null காலாவதியான தேதி வரை முழு நாட்கள், காலாவதியான பிறகு எதிர்மறை
is_expired, needs_renewal_soon boolean களம் காலாவதியாகிவிட்டதா அல்லது அடுத்த 30 நாட்களில் காலாவதியாகும்
auto_renew, renewal_period_years boolean, integer களம் தானாக புதுப்பிக்கப்பட வேண்டுமா, மற்றும் எத்தனை ஆண்டுகளுக்கு
registration_price, renewal_price string டெசிமல் சரங்களாக 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, net, 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
}

விலைகள் ஒரு ஆண்டுக்கு USD யில் உள்ள எண்கள் மற்றும் கிடைக்காத பெயர்களுக்கு புள்ளிகள். விலைகள் காட்டப்பட்டுள்ளன.

பதில் நிலை குறியீடுகள்

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/

களத்தை புதுப்பி

களத்தை புதுப்பிக்கும் மற்றும் ஒவ்வொரு ஆண்டும் அதன் புதுப்பிப்பு_ விலையை உங்கள் சேமிக்கப்பட்ட செலுத்தும் முறைக்கு செலுத்துகிறது.

அனுமதி தேவை: 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/

பெயர் சேவையகங்களை புதுப்பி

களத்தின் பெயர் சேவையகங்களை பதிவு செய்யும் இடத்தில் அமைத்து புதுப்பிக்கப்பட்ட கள பொருளை திரும்ப வழங்குகிறது. DNS API உடன் DNS ஐ நிர்வகிக்க, 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 பெயர் சேவையகம்1 காணவில்லை
404 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது
500 புதுப்பித்தல் தோல்வியடைந்தது; உடல் பிழை மற்றும் செய்தி புலங்களை கொண்டுள்ளது
PUT /api/v1/domains/{uuid}/auto-renew/

தானாக புதுப்பித்தலை செயல்படுத்து அல்லது செயல் நீக்கு

auto_renew அமைத்து புதுப்பிக்கப்பட்ட கள பொருளை திரும்ப வழங்கும். JSON புளூயன் ஆக அனுப்பு: எந்த காலியான சரமும், சரம் false உள்ளிட்ட, தானாக புதுப்பிக்கத் தொடங்கும்.

அனுமதி தேவை: 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 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது

குறிப்புகள்