VPS.org API

REST API मिसिलीकरण

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

तपाईंको डोमेनहरूको लागि प्रोग्रामेटिक रूपमा DNS क्षेत्रहरू र रेकर्डहरू व्यवस्थापन गर्नुहोस्।

अन्तिम बिन्दुहरू ४ अन्त्यबिन्दुहरू
आधार मार्ग /api/v1/dns-zones
प्रमाणीकरण आवश्यक बोक्ने टोकन

अवलोकन

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

नाम सर्भर पूर्वाधार

कुञ्जी विशेषताहरू

प्रमाणीकरण

सबै डीएनएस एपीआई अनुरोधहरू बोक्ने टोकन प्रमाणीकरण आवश्यक पर्दछ। आफ्नो खाता डैशबोर्डबाट एपीआई टोकनहरू उत्पन्न गर्नुहोस् /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}/

DNS क्षेत्र विवरणहरू प्राप्त गर्नुहोस्

सबै रेकर्ड सहित, विशिष्ट डीएनएस क्षेत्रको बारेमा विस्तृत जानकारी पुन: प्राप्त गर्नुहोस् ।

मार्ग प्यारामिटरहरू

परिमिति प्रकारहरू आवश्यक छ वर्णन
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 क्षेत्र सिर्जना गर्नुहोस्

Create a new DNS zone for a domain. The zone will be immediately deployed to VPS.org nameservers.

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

परिमिति प्रकारहरू आवश्यक छ वर्णन
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 क्षेत्र मेट्नुहोस्

स्थायी रूपमा डीएनएस क्षेत्र र सबै सम्बन्धित रेकर्ड मेट्नुहोस् । यो कार्य पूर्वस्थितिमा फर्काउन सकिँदैन ।

मार्ग प्यारामिटरहरू

परिमिति प्रकारहरू आवश्यक छ वर्णन
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}/

DNS रेकर्डहरू प्रबन्ध गर्नुहोस् (प्रत्यक्ष पहुँच)

रेकर्ड UUID प्रयोग व्यक्तिगत DNS रेकर्ड मा पूर्ण CRUD सञ्चालनहरू।

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

क्वेरी परिमितिहरू (GET /api/v1/dns-records/ को लागि)

Parameter प्रकारहरू वर्णन
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"
}

डीएनएस परिवर्तन परीक्षण गर्दै

रेकर्ड प्रसारण रुजु गर्नुहोस्

# 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

अनलाइन उपकरण प्रयोग गर्दै