VPS.org API

डेटी एपीआई प्रलेख

डोमेन्स एपीआई

उपलब्ध डोमेन नामों, रजिस्टर व नव डोमेनों के लिए ढूंढें, और उनके नामसर्वर तथा स्वचालित स्व- हस्ताक्षरित. डोमेनों की पहचान उनके ududom द्वारा की जाती है.

अंतिमबिंदुओं 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 जब डोमेन को पंजीकृत किया जाता है और जब वह खत्म होता है. eudu_t date को नल कर सकता है.
days_until_expiration integer | null समाप्ति तिथि तक संपूर्ण दिन, नकारात्मक एक बार समाप्त हो गया (_u)
is_expired, needs_renewal_soon boolean क्या डोमेन के समय समाप्त हो गया है, और क्या यह अगले 30 दिनों के भीतर खत्म हो गया है.
auto_renew, renewal_period_years boolean, integer क्या डोमेन को स्वचालित नया आकार देता है, और कितने वर्षों तक
registration_price, renewal_price string यूएसडी में मूल्य दशमलव स्ट्रिंग के रूप में
whois_privacy, transfer_lock boolean ISPACAC तथा रजिस्ट्रार लॉक सेटिंग
nameserver1 to nameserver4 string | null डोमेन का नामसर्वर
created_at, updated_at datetime जब रिकार्ड किया गया और अंतिम परिवर्तन किया गया (ISO 8601, यूटी.)
पाना /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/

डोमेन आस्कीमेंट्सन खोजें

जाँच करता है कि क्या नाम लगभग २० लोकप्रिय विस्तार (अप्रैल, net, kde, H, ए, एई, ए, ए तथा अधिक, के- अतिरिक्‍त, से अधिक) के बारे में उपलब्ध है या नहीं. जाँच करें कि क्या यह सही मात्रा में नहीं है. जाँच करें कि कौन सा नाम प्राप्त किया गया है, तब उपलब्ध हैं.

अनुमति: domains:search

अनुरोध निकाय पैरामीटर

पैरामीटर प्रकार आवश्यक वर्णन
domain string हाँ extension के साथ या बिना एक name, उदाहरण के लिए mysite या mysite.com (2 से 63 characters)

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

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 गुम डोमेन, या इसमें अक्षर हैं अक्षर, अंक तथा scents के अलावा अन्य अक्षर हैं
500 रजिस्ट्रार देखना विफल. बाद में फिर कोशिश करें.
रूट /api/v1/domains/register/

नया डोमेन पंजीकृत करें

Bangalcentt और आपके संरक्षण विधि का समर्थन. आगामीता और मूल्य फिर से अधिकारी के साथ चेक किया जाता है। रीग्रेसन संपर्क विवरण आपके खाते प्रोफ़ाइल से ले लिया जाता है। यदि रजिस्ट्रार रजिस्टर करने के बाद रजिस्टर्टी को अस्वीकार करता है, तो भुगतान रिवित किया जाता है.

अनुमति: domains:register ( डोमेन से अलग है:*)

अनुरोध निकाय पैरामीटर

पैरामीटर प्रकार आवश्यक वर्णन
domain string हाँ उदाहरण के लिए, पूरा डोमेन नाम जिसमें उसका विस्तार भी शामिल है, उदाहरण के लिए.com
years integer नहीं पंजीकरण अवधि, 1 से 10 (डिफ़ॉल्ट 1.). मूल्य प्रत्येक मूल्य है साल के लिए कम से कम 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 फ़ाइल पर कोई भुगतान विधि, या scrats में
500 भुगतान अण्डा को प्रोसेस नहीं किया जा सका, या ऋण के बाद रजिस्ट्रार ने पंजीकरण अस्वीकार किया ।
रूट /api/v1/domains/{uuid}/renew/

डोमेन फिर से बनाएँ

आपके सहेजे गए भुगतान विधि के लिए डोमेन को नया और आरोप लगाने के लिए हर साल उसके नवीकरण _In_BAR_ PR_

अनुमति: 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/

सर्वर से वापस लें

registrar पर domain के nameservers सेट करता है और updated domain object लौटाता है। DNS API से DNS manage करने के लिए, ns1.vps.org, ns2.vps.org और ns3.vps.org का उपयोग करें और domain के लिए एक 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 सर्वर नामserver का अद्यतन, शरीर डोमेन वस्तु है
400 सर्वर यूआरएल:% 1 गुम है
404 नहीं मिला, या यह अन्य खाता है
500 अद्यतन असफल; शरीर में त्रुटि और संदेश फ़ील्ड है
PUT /api/v1/domains/{uuid}/auto-renew/

स्वचालित- नया- ऑन चालू करें या बन्द करें

स्वचालित रूप से प्रारंभ करने के लिए तथा अद्यतन डोमेन वस्तु को लौटाता है. भेजें < Dacent shat', किसी भी गैर रिक्त वाक्यांश को, जिसमें वाक्यांश गलत है, स्वतः नया डाउनलोड करता है.

अनुमति: 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 नहीं मिला, या यह अन्य खाता है

टिप्पणी