VPS.org API

REST API दस्तऐवजीकरण

DNS व्यवस्थापन API

तुमच्या डोमेनसाठी प्रोग्रामॅटिकली DNS झोन आणि रेकॉर्ड व्यवस्थापित करा.

शेवटचे बिंदू ४ एंडपॉइंट्स
बेस पाथ /api/v1/dns-zones
प्रमाणीकरण चालक टोकन आवश्यक

आढावा

डीएनएस API डीएनएस क्षेत्रे आणि नोंदी पूर्ण व्यवस्थापन प्रदान करते. सर्व क्षेत्रे स्वचालित BIND9 क्षेत्र फाइल निर्मिती आणि वितरणसह VPS.org च्या अधिकार्‍याच्या नाव सर्वरवर होस्ट केले जातात.

नाव- सर्वर पायाभूत सुविधा

मुख्य वैशिष्ट्ये

प्रमाणीकरण

सर्व DNS API विनंती करीता Bearer Token प्रमाणीकरणाची आवश्यकता असते. तुमच्या खात्यामधील डॅशबोर्ड पासून API Tokens निर्माण करा येथे /account/developers/ खालिल परवानगीसह:

उदाहरण

Authorization: Bearer vps_abc123def456...
महत्वाचे: API टोकन निर्माण करतेवेळी फक्त एकदाच दर्शविले जातात. त्यांना सुरक्षितरित्या साठवा. जर तुम्ही टोकन गमावलात तर, तुम्हाला नविन एक निर्माण करावे लागेल.
मिळवा /api/v1/dns-zones/

सर्व DNS झोन सूचीबद्ध करा

अधिप्रमाणीत वापरकर्ता करीता सर्व DNS क्षेत्रांची पानबद्ध यादी प्राप्त करा. क्षेत्र नाव द्वारे फिल्टर करीता समर्थन पुरविते.

क्वेरी पॅरामीटर्स

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

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

क्षेत्र प्रकार वर्णन@ title: window
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}/

DNS क्षेत्र तपशील प्राप्त करा

या सर्व नोंदींचा समावेश असलेल्या विशिष्ट डीएनएस क्षेत्राविषयी विस्तृत माहिती प्राप्त करा.

पथ पॅरामीटर्स

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

DNS क्षेत्र बनवा

क्षेत्र करीता नविन DNS क्षेत्र बनवा. क्षेत्र तात्काळ VPS.org नाव सर्वर करीता वितरीत केले जाईल.

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

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

DNS क्षेत्र नष्ट करा

DNS क्षेत्र व सर्व संबंधित नोंदणी कायमचे नष्ट करा. ही क्रिया रद्द केली जाऊ शकत नाही.

पथ पॅरामीटर्स

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

क्षेत्र अंतर्गत DNS नोंदणीची यादी

या सर्व संकल्पना ॲरिस्टॉटलच्या तत्त्वज्ञानात (तत्त्वज्ञानाच्या संकल्पना) समाविष्ट केल्या गेल्या आहेत.

पथ पॅरामीटर्स

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

क्षेत्र अंतर्गत DNS नोंदणी बनवा

विशिष्ट क्षेत्र (नियंत्रीत मार्ग) करीता नविन DNS नोंदणी जोडा.

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

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

DNS नोंदणीचे व्यवस्थापन करा (प्रत्यक्ष प्रवेश) Name

प्रत्येक वेळी डीएनए चाचणी करून त्याचे गुणधर्म शोधले जातात.

उपलब्ध क्रिया

क्वेरी परिमाणे (GET /api/v1/dns-records/ करीता)

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

उदाहरण: रेकॉर्डचे TTL अद्ययावत करा

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" नाही

सर्वोत्तम प्रथा

TTL संयोजना

सामान्य रचना

सुरक्षा

त्रुटी हाताळणी

सामान्य त्रुटी

स्थिती कोड त्रुटी सोडवणूक
400 अवैध क्षेत्र नाव क्षेत्र डीएनएस नावे ठेवण्याच्या करारांचे पालन करते याची खात्री करा
400 MX रेकॉर्डला प्राधान्यता आवश्यक आहे समाविष्ट करा priority MX व SRV रेकॉर्ड करीता क्षेत्र
401 अवैध API टोकन टोकन स्वरूपन तपासा (यासह सुरू करा) vps_)
403 हवी असलेली परवानगी आवश्यक नुरूप नविन टोकन बनवा dns:* परवानगी
404 क्षेत्र/रेकॉर्ड आढळले नाही UUID तपासा व स्त्रोत तुमच्या खात्याशी संबंधित आहे याची खात्री करा

उदाहरण त्रुटी प्रतिसाद

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

DNS बदल चाचणी करीत आहे

रेकॉर्ड प्रक्षेपण तपासा

# 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

ऑनलाईन साधन वापरत आहे