VPS.org API

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

DNS प्रबंधन API

अपने डोमेन के लिए DNS ज़ोन और रिकॉर्ड को प्रोग्रामेटिक रूप से प्रबंधित करें।

अंतिमबिंदुओं 4 अंतिम बिंदु
आधार पथ /api/v1/dns-zones
प्रमाणीकरण बीयर टनन आवश्यक

अवलोकन

डीएनएस एपीआई डाटा तथा रिकॉर्ड प्रदान करता है. सभी क्षेत्रों में VPS.org के आधिकारिक नामसर्वर पर सेवा की जाती है स्वचालित BIND9 क्षेत्र सेवा और तैनात करने के लिए.

सर्वर्स इन्फ्फोर्सस का नाम

कुंजी फीचर

प्रमाणीकरण

सभी डीएनएस एपीआई आग्रह करता है बीयर टोकन सत्यापन की जरूरत है. अपने खाता बर्निंग बोर्ड पर से एपीआई टोकन तैयार करें /account/developers/ निम्न अनुमति से:

उदाहरण

Authorization: Bearer vps_abc123def456...
आयात और न उनको अज़ाब से मोहलत दी जाएगी और (ऐ रसूल) तुम उन निशानियों को उस वक्त तक (नमाज़ में) डाल दो कि अगर तुम कोई मौजिज़ा खो दो तो (समझ लो कि) फिर नया पैदा करो (और) फिर एक वक्त मुक़र्रर किया जाएगा
पाना /api/v1/dns-zones/

सभी DNS ज़ोन की सूची बनाएं

सत्यापित किए गए उपयोक्ता द्वारा दिए गए सभी डीएनएस क्षेत्रों की लंबाई प्राप्त करें. डोमेन नाम के समर्थन को समर्थित करता है.

क्वेरी पैरामीटर

पैरामीटर प्रकार आवश्यक वर्णन
domain string नहीं Filter zones by exact domain name (e.g., example.com)

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

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/dns-zones/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/dns-zones/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/dns-zones/', {
  headers: {'Authorization': 'Bearer YOUR_API_TOKEN'}
});

const zones = await response.json();
console.log(zones);

उदाहरण प्रतिक्रिया

[
  {
    "uuid": "abc123-def456-ghi789",
    "domain": "example.com",
    "created_at": "2024-01-15T10:30:00Z",
    "record_count": 12
  },
  {
    "uuid": "xyz789-uvw456-rst123",
    "domain": "myapp.io",
    "created_at": "2024-06-20T14:15:00Z",
    "record_count": 8
  }
]

प्रतिक्रिया क्षेत्र

क्षेत्र प्रकार वर्णन
uuid string Unique zone identifier (used in API requests)
domain string Domain name for this DNS zone
created_at datetime Zone creation timestamp (ISO 8601 format)
record_count integer Total number of DNS records in this zone

प्रतिक्रिया स्थिति कोड

200 Successfully retrieved DNS zones list
401 Unauthorized - Invalid or missing API token
403 Forbidden - Token lacks dns:list permission
पाना /api/v1/dns-zones/{uuid}/

डीएनएस सर्विस विवरण प्राप्त करें

विशिष्ट डीएनएस क्षेत्र के बारे में विस्तृत जानकारी प्राप्त करें, जिसमें सभी रिकॉर्ड शामिल हैं.

पथ पैरामीटर

पैरामीटर प्रकार आवश्यक वर्णन
uuid string हाँ Unique zone identifier

उदाहरण प्रतिक्रिया

{
  "uuid": "abc123-def456-ghi789",
  "domain": "example.com",
  "created_at": "2024-01-15T10:30:00Z",
  "record_count": 5,
  "records": [
    {
      "uuid": "rec-001",
      "record_type": "A",
      "name": "@",
      "value": "192.0.2.1",
      "ttl": 3600,
      "priority": null,
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "uuid": "rec-002",
      "record_type": "MX",
      "name": "@",
      "value": "mail.example.com",
      "ttl": 3600,
      "priority": 10,
      "created_at": "2024-01-15T10:32:00Z"
    }
  ]
}

प्रतिक्रिया स्थिति कोड

200 Successfully retrieved zone details
404 Zone not found or not owned by user
रूट /api/v1/dns-zones/

डीएनएस सूट बनाएँ

डोमेन के लिए नया डीएनएस क्षेत्र बनाएँ. क्षेत्र तत्काल VPS.org नामसर्वर पर तैनात किया जाएगा.

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

पैरामीटर प्रकार आवश्यक वर्णन
domain string हाँ Domain name (e.g., example.com)

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

cURL
Python
JavaScript
curl -X POST "https://admin.vps.org/api/v1/dns-zones/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "newdomain.com"}'
import requests

url = "https://admin.vps.org/api/v1/dns-zones/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {"domain": "newdomain.com"}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/dns-zones/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({domain: 'newdomain.com'})
});

const zone = await response.json();
console.log(zone);

उदाहरण प्रतिक्रिया

{
  "uuid": "new-zone-uuid",
  "domain": "newdomain.com",
  "created_at": "2026-01-18T16:45:00Z",
  "record_count": 0,
  "records": []
}

प्रतिक्रिया स्थिति कोड

201 DNS zone created successfully
400 Bad Request - Invalid domain name or zone already exists
403 Forbidden - Token lacks dns:create permission
मिटाना /api/v1/dns-zones/{uuid}/

डीएनएस टाइम- आउटः मिटाएँ (y)

डीएनएस क्षेत्र तथा सभी सम्बद्ध रिकार्डों को स्थायी रूप से मिटा दें. यह क्रिया वापस नहीं की जा सकती.

पथ पैरामीटर

पैरामीटर प्रकार आवश्यक वर्णन
uuid string हाँ Unique zone identifier

प्रतिक्रिया स्थिति कोड

204 Zone deleted successfully (no response body)
403 Forbidden - Token lacks dns:delete permission
404 Zone not found
पाना /api/v1/dns-zones/{uuid}/records/

आयोजक में डीएनएस अभिलेखों की सूची दें

विशिष्ट क्षेत्र के लिए सभी डीएनएस रिकॉर्ड प्राप्त करें (सबसे सीधा मार्ग).

पथ पैरामीटर

पैरामीटर प्रकार आवश्यक वर्णन
uuid string हाँ Zone UUID

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

curl -X GET "https://admin.vps.org/api/v1/dns-zones/{uuid}/records/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

उदाहरण प्रतिक्रिया

[
  {
    "uuid": "rec-001",
    "record_type": "A",
    "name": "@",
    "value": "192.0.2.1",
    "ttl": 3600,
    "priority": null,
    "created_at": "2024-01-15T10:30:00Z"
  },
  {
    "uuid": "rec-002",
    "record_type": "MX",
    "name": "@",
    "value": "mail.example.com",
    "ttl": 3600,
    "priority": 10,
    "created_at": "2024-01-15T10:32:00Z"
  }
]
रूट /api/v1/dns-zones/{uuid}/records/

क्षेत्र में डीएनएस रेकॉर्ड बनाएँ

विशिष्ट क्षेत्र में नया डीएनएस रेकॉर्ड जोड़ें (सबसे सीधा मार्ग).

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

पैरामीटर प्रकार आवश्यक वर्णन
record_type string हाँ Record type: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA
name string हाँ Record name (@ for root, subdomain, or FQDN)
value string हाँ Record value (IP address, hostname, text)
ttl integer No Time to live in seconds (default: 3600)
priority integer For MX/SRV Priority (required for MX and SRV records)

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

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/dns-zones/{uuid}/records/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "record_type": "A",
    "name": "www",
    "value": "192.0.2.1",
    "ttl": 3600
  }'
import requests

url = f"https://admin.vps.org/api/v1/dns-zones/{zone_uuid}/records/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "record_type": "A",
    "name": "www",
    "value": "192.0.2.1",
    "ttl": 3600
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

प्रतिक्रिया स्थिति कोड

201 DNS record created successfully
400 Bad Request - Invalid parameters or validation error (e.g., MX record missing priority)
GET PUT PATCH DELETE /api/v1/dns-records/{uuid}/

डीएनएस अभिलेख प्रबंधित करें (कोई बाहरी पहुँच नहीं)

UDD रिकार्ड के प्रयोग से व्यक्‍तिगत डीएनएस रिकॉर्ड पर पूरा सविनिम ऑपरेशन.

उपलब्ध संचालन

क्वैरी पैरामीटर (मान //v1/sss/)

Parameter प्रकार वर्णन
zone string Filter records by zone UUID
record_type string Filter by record type (A, AAAA, MX, etc.)

उदाहरण: रिकॉर्ड के टीटीएल का अद्यतन

curl -X PATCH "https://admin.vps.org/api/v1/dns-records/{rec-uuid}/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ttl": 1800}'

Supported DNS Record Types

प्रकार Purpose Example Value Priority Required
A Maps domain to IPv4 address 192.0.2.1 नहीं
AAAA Maps domain to IPv6 address 2001:0db8::1 नहीं
CNAME Creates alias to another domain example.com नहीं
MX Mail server for domain mail.example.com हाँ
TXT Text record (SPF, DKIM, verification) v=spf1 include:_spf.google.com ~all नहीं
NS Nameserver delegation ns1.example.com नहीं
SRV Service location record 10 5060 sip.example.com हाँ
CAA Certificate authority authorization 0 issue "letsencrypt.org" नहीं

बढ़िया अभ्यास

टीटीएल कॉन्फ़िगरेशन

सामान्य पैटर्न

सुरक्षा

सिंकिंग में त्रुटि

सामान्य त्रुटियाँ

स्थिति कोड त्रुटि समाधान
400 डोमेन का नाम अमान्य है डीएनएस नामकरण अधिवेशनों के बाद सुनिश्चित करें
400 MX रिकार्ड को प्राथमिकता की जरूरत है शामिल करें priority एमएक्स तथा एसआरवी रिकार्ड के लिए फ़ील्ड
401 अवैध एपीआई टोकन टोकन फॉर्मेट जाँचें (के साथ प्रारंभ होना चाहिए) vps_)
403 अनुमति गुम है आवश्यक के साथ नया टोकन बनाएँ dns:* अनुमतियाँ
404 क्षेत्र/ क्रम में नहीं मिला यूटीपी तथा संसाधन आपके खाते का होता है सुनिश्चित करें

उदाहरण त्रुटि प्रतिक्रिया

{
  "detail": "MX records require a priority value",
  "error_code": "validation_error",
  "field": "priority"
}

डीएनएस परिवर्तन जाँच रहा है

रेकॉर्ड प्रोग्रेसिव

# Query A record
dig example.com A

# Query specific nameserver
dig @ns1.vps.org example.com

# Query MX records
dig example.com MX

# Check all records
dig example.com ANY

ऑनलाइन औज़ारों का उपयोग किया जा रहा है