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

प्रतिसाद फील्ड

क्षेत्र प्रकार वर्णन@ title: window
uuid string इतर क्षेत्र अंतबिंदू अंतर्गत वापरले जाणारे क्षेत्र ओळखकर्ता
status string active, pending, expired, cancelled, transferred
registrar string क्षेत्र येथे ठेवले गेलेले रजिस्ट्रार
registration_date, expiration_date datetime या वेळी त्याचे वजन कमी होते व त्याचे वजन वाढते, त्यामुळे त्याचे वजन कमी होते.
days_until_expiration integer | null संपण्यापूर्वीचे दिवस (_d), संपल्यावर नकारात्मक
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

बॉडी पॅरामीटर्सची विनंती करा

परिमाण प्रकार आवश्यक वर्णन@ title: window
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
}

या योजनेत एक वर्षासाठी 1000 रुपये खर्च येतो व योजनेत सहभागी होणाऱ्या व्यक्तीला 1000 रुपये देय असतात.

प्रतिसाद स्थिती कोड

200 यशस्वी
400 क्षेत्र आढळले नाही, किंवा यांत अक्षरे, अंक व हायफन व्यतिरिक्त इतर अक्षरे समाविष्टीत आहेत
500 रजिस्टर शोध अपयशी ठरला. नंतर पुन्हा प्रयत्न करा.
पोस्ट /api/v1/domains/register/

नवीन डोमेन नोंदणी करा

क्षेत्र नोंदणी करीत आहे व तुमच्या संचयीत विनिमय पद्धती चार्ज करते. उपलब्धता व किंमत चार्ज करण्यापूर्वी पुन्हा रेकॉर्डरशी तपासली जाते. नोंदणीकर्ता सम्पर्क तपशील तुमच्या खात्यापासून प्रोफाइलपासून घेतले जातात. चार्ज केल्यानंतर रेकॉर्डरने नोंदणी नाकारल्यास, पैसे परत केले जातात.

आवश्यक परवानगी: domains:register (क्षेत्र द्वारे पुरविले: *)

बॉडी पॅरामीटर्सची विनंती करा

परिमाण प्रकार आवश्यक वर्णन@ title: window
domain string होय विस्तारण समाविष्टीत पूर्ण क्षेत्र नाव, उदाहरणार्थ example. com
years integer नाही Registration period, 1 to 10 (default 1). The price is the yearly price times years. .ai requires at least 2 years; 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}'

उदाहरण प्रतिसाद

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

बॉडी पॅरामीटर्सची विनंती करा

परिमाण प्रकार आवश्यक वर्णन@ title: window
years integer नाही जोडण्याकरीता वर्ष, 1 ते 10 (मासिक) 
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

बॉडी पॅरामीटर्सची विनंती करा

परिमाण प्रकार आवश्यक वर्णन@ title: window
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 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 आढळले नाही किंवा ते इतर खात्याशी संबंधित आहे

टिपण्णी