VPS.org API

REST API मिसिलीकरण

डोमेन API

उपलब्ध डोमेन नामहरूका लागि खोजी गर्नुहोस्, दर्ता गर्नुहोस् र डोमेनहरू अद्यावधिक गर्नुहोस्, र तिनीहरूको नाम सर्भर र स्वचालित-अद्यावधिक प्रबन्ध गर्नुहोस् । डोमेनहरू तिनीहरूको uuid द्वारा पहिचान गरिन्छ ।

अन्तिम बिन्दुहरू 7
आधार मार्ग /api/v1/domains
प्राप्त गर्नुहोस् /api/v1/domains/

सबै डोमेनहरू सूचीबद्ध गर्नुहोस्

तपाईँको खातामा दर्ता गरिएको डोमेन फर्काउँछ, प्रति पृष्ठ २५। सूचीमा फिल्टर छैन ।

अनुमति आवश्यक: 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 डोमेनको म्याद समाप्त भएको छ या छैन, र यदि यो पछिल्लो ३० दिन भित्र म्याद समाप्त हुन्छ भने
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/

डोमेन उपलब्धता खोजी गर्नुहोस्

यदि नाम २० लोकप्रिय विस्तार (com, net, org, io, dev, co, app, ai र धेरै) भित्र उपलब्ध छ भने जाँच गर्दछ, प्लस तपाईँले टाइप गर्नुभएको विस्तार यदि यो तिनीहरू बीचमा छैन भने । परिणाम सहि मिल्दोसँग सुरु हुन्छ, त्यसपछि उपलब्ध नाम, त्यसपछि लिइएकाहरू ।

अनुमति आवश्यक: domains:search

अनुरोध बडी प्यारामिटरहरू

परिमिति प्रकारहरू आवश्यक छ वर्णन
domain string हो विस्तारसँग वा विस्तार बिनाको नाम, उदाहरणका लागि mysite वा mysite.com (२ देखि ६३ क्यारेक्टर)

उदाहरण अनुरोध

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 होइन 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/

डोमेन अद्यावधिक गर्नुहोस्

डोमेन नवीकरण र आफ्नो बचत भुक्तानी विधि प्रत्येक वर्ष लागि यसको renewal_price चार्ज गर्दछ।

अनुमति आवश्यक: domains:renew

अनुरोध बडी प्यारामिटरहरू

परिमिति प्रकारहरू आवश्यक छ वर्णन
years integer होइन १ देखि १० सम्म थप्नका लागि वर्षहरू (पूर्वनिर्धारित १) 
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/

नाम सर्भर अद्यावधिक गर्नुहोस्

दर्ताकर्तामा डोमेनको नाम सर्भर सेट गर्दछ र अद्यावधिक डोमेन वस्तु फर्काउँछ। डीएनएस एपीआईसँग डीएनएस व्यवस्थापन गर्न, 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 नाम सर्भर १ हराइरहेको छ
404 फेला परेन, वा यो अर्को खातासँग सम्बन्धित छ
500 अद्यावधिक असफल भयो; मुख्य भागमा त्रुटि र सन्देश फिल्डहरू छन्
PUT /api/v1/domains/{uuid}/auto-renew/

स्वत: अद्यावधिक सुरु वा बन्द गर्नुहोस्

स्वचालित अद्यावधिक सेट गर्दछ र अद्यावधिक डोमेन वस्तु फर्काउँछ । JSON बुलियनको रूपमा सक्षम पारिएको पठाउनुहोस्: कुनै खाली स्ट्रिङ, स्ट्रिङ गलत समावेश गरेर, स्वचालित अद्यावधिक सुरु गर्दछ ।

अनुमति आवश्यक: 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 फेला परेन, वा यो अर्को खातासँग सम्बन्धित छ

द्रष्टब्य