VPS.org API

REST API ஆவணமாக்கல்

DNS மேலாண்மை API

உங்கள் டொமைன்களுக்கான DNS மண்டலங்கள் மற்றும் பதிவுகளை நிரல் ரீதியாக நிர்வகிக்கவும்.

முனைப்புள்ளிகள் 4 முனைப்புள்ளிகள்
அடிப்படை பாதை /api/v1/dns-zones
அங்கீகாரம் பைரர் டாக்கன் தேவை

கண்ணோட்டம்

DNS API DNS பகுதிகள் மற்றும் பதிவுகளின் முழுமையான மேலாண்மையை வழங்குகிறது. அனைத்து பகுதிகளும் VPS.org ன் அதிகாரப்பூர்வ பெயர் சேவையகங்களில் தானாகவே BIND9 பகுதி கோப்பு உருவாக்கம் மற்றும் நிறுவுதல் மூலம் வசிக்கும்.

பெயர் சேவையக கட்டமைப்பு

முக்கியமான அம்சங்கள்

அங்கீகாரம்

அனைத்து DNS API கோரிக்கைகளுக்கும் Bearer Token உறுதிப்படுத்தல் தேவை. உங்கள் கணக்கு கட்டுப்பாட்டுப் பலகத்தில் இருந்து API Tokens உருவாக்கவும் /account/developers/ பின்வரும் அனுமதிகளுடன்:

உதாரணம்

Authorization: Bearer vps_abc123def456...
முக்கியமானது: API குறிகள் உருவாக்கும் போது ஒருமுறை மட்டுமே காட்டப்படும். அவற்றை பாதுகாப்பாக சேமிக்கவும். நீங்கள் ஒரு குறியை இழந்தால், நீங்கள் புதிய ஒன்றை உருவாக்க வேண்டும்.
பெறு /api/v1/dns-zones/

அனைத்து DNS மண்டலங்களையும் பட்டியலிடுங்கள்

அனைத்து 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 மண்டல விவரங்களை பெறு

குறிப்பிட்ட 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 பகுதியை உருவாக்கு

ஒரு களம்க்கான புதிய டிஎன்எஸ் பகுதியை உருவாக்கவும். இந்த பகுதி உடனடியாக 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}/

DNS பகுதியை நீக்கு

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/

DNS பதிவுகளை பட்டியல் செய்

குறிப்பிட்ட பகுதிக்கு (நுழைந்த பாதை) அனைத்து டிஎன்எஸ் பதிவுகளையும் பெறுக.

பாதை அளவுருக்கள்

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
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 பதிவை உருவாக்கு

குறிப்பிட்ட பகுதிக்கு புதிய டிஎன்எஸ் பதிவை சேர்க்கவும் (நெட்வொர்க் பாதை).

கோரிக்கை உடல் அளவுருக்கள்

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
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

பதிவு 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 செல்லாத களம் பெயர் களம் DNS பெயர் அமைப்புகளை பின்பற்றுவதைத் தயவு செய்து உறுதிசெய்
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

இணைய கருவிகளை பயன்படுத்துதல்