VPS.org API

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

DNS மேலாண்மை API

DNS பகுதிகளை உருவாக்கவும் அவற்றின் பதிவுகளை நிர்வகிக்கவும். ns1. vps.org, ns2. vps.org மற்றும் ns3. vps.org மூலம் சேவை செய்யப்படும் பகுதிகள்.

முனைப்புள்ளிகள் 13
அடிப்படை பாதை /api/v1/dns-zones, /api/v1/dns-records

கண்ணோட்டம்

ஒரு பகுதி ஒரு களம் பதிவுகளை வைத்திருக்கிறது. API மூலம் நீங்கள் செய்யும் ஒவ்வொரு மாற்றமும் VPS.org பெயர் சேவையகங்களுக்கு உடனடியாக நகர்த்தப்படுகிறது. இந்த பகுதிகளில் இருந்து ஒரு களம் சேவை செய்ய, உங்கள் பதிவாளர் ns1. vps.org, ns2. vps.org மற்றும் ns3. vps.org க்கு அதன் பெயர் சேவையகங்களை அமைக்கவும்.

மாற்றங்கள் சேமிக்கப்படும் மற்றும் ஒரு படியில் வெளியிடப்படும்: பெயர் சேவையகங்கள் மாற்றத்தை நிராகரித்தால், கோரிக்கை 502 திரும்பும் மற்றும் எதுவுமே சேமிக்கப்படாது. ஒரு களத்திற்கு ஒரு மண்டலத்தை உருவாக்க முடியாது, மற்ற கணக்கு ஏற்கனவே நிர்வகிக்கிறது, மற்ற கணக்கு மண்டலத்தின் பெற்றோராக அல்லது குழந்தையாக, அல்லது VPS.org காப்பிடப்பட்ட பெயர்.

அனுமதி தேவை: dns:list (GET), dns:create (POST), dns:update (PUT, PATCH, sync), dns:delete (DELETE), dns:*

பெறு /api/v1/dns-zones/

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

உங்கள் பகுதிகளை திரும்ப தரும், புதிய முதல், பக்கத்திற்கு 25. பதிவுகள் இங்கே சேர்க்கப்படவில்லை; அவற்றை பெற ஒரு தனிப்பட்ட பகுதியை பெறவும்.

வினவல் அளவுருக்கள்

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
domain string இல்லை இந்த களப் பெயருடன் மட்டுமே வட்டத்தை திரும்ப அனுப்பு
page integer இல்லை பக்க எண், 1ல் தொடங்குகிறது

மாதிரி கோரிக்கை

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/dns-zones/?domain=example.com" \
  -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, params={"domain": "example.com"})
for zone in response.json()["results"]:
    print(zone["uuid"], zone["domain"], zone["record_count"])
const response = await fetch('https://admin.vps.org/api/v1/dns-zones/?domain=example.com', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

எடுத்துக்காட்டு பதில்

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c",
      "domain": "example.com",
      "created_at": "2026-09-06T03:11:48.829693Z",
      "record_count": 5
    }
  ]
}

பதில் புலங்கள்

புலங்கள் வகை & விவரக்குறிப்புகள்
uuid string பகுதி அடையாளம்
domain string களம் பெயர், சிறிய எழுத்துகளில் சேமிக்கப்படுகிறது
created_at datetime உருவாக்கும் நேரம் (ISO 8601, UTC)
record_count integer மூன்று NS பதிவுகளை உள்ளடக்கிய பகுதியில் உள்ள பதிவுகளின் எண்ணிக்கை

பதில் நிலை குறியீடுகள்

200 வெற்றி
403 காணாமல் போன அல்லது செல்லாத API டாக், அல்லது டாக் தேவையான அனுமதியைக் கொண்டிருக்கவில்லை
அஞ்சல் /api/v1/dns-zones/

DNS பகுதியை உருவாக்கு

ஒரு மண்டலத்தை உருவாக்குகிறது மற்றும் வெளியிடுகிறது. மண்டலம் ns1, ns2 மற்றும் ns3. vps.org க்கு மூன்று NS பதிவுகளுடன் தொடங்குகிறது, அவை அமைப்பு பதிவுகள் மற்றும் திருத்த அல்லது நீக்க இயலாது.

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

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
domain string ஆம் களப் பெயர், உதாரணமாக example. com
curl -X POST "https://admin.vps.org/api/v1/dns-zones/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "example.com"}'

எடுத்துக்காட்டு பதில்

{
  "uuid": "c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c",
  "domain": "example.com",
  "created_at": "2026-09-14T21:02:11.402113Z",
  "records": [
    {
      "uuid": "1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b",
      "record_type": "NS",
      "name": "@",
      "value": "ns1.vps.org",
      "ttl": 86400,
      "priority": null,
      "created_at": "2026-09-14"
    },
    ...
  ],
  "record_count": 3
}

பதில் நிலை குறியீடுகள்

201 பகுதி உருவாக்கப்பட்டது
400 காணாத அல்லது செல்லாத களம் பெயர்
பெறு /api/v1/dns-zones/{uuid}/

DNS மண்டல விவரங்களை பெறு

ஒரு பதிவு அடுக்கில் உள்ள அனைத்து பதிவுகளுடன் ஒரு பகுதியை திரும்பும். மேலே உள்ள உருவாக்க பதில் போன்றே பதில் இருக்கும்.

curl -X GET "https://admin.vps.org/api/v1/dns-zones/c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

பதில் நிலை குறியீடுகள்

200 வெற்றி
404 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது
நீக்கு /api/v1/dns-zones/{uuid}/

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

மூன்று பெயர் சேவையகங்களிலிருந்தும் மண்டலத்தை நீக்குகிறது, அவைகளில் ஒன்றும் இன்னும் சேவை செய்யவில்லை என்பதை சரிபார்க்கவும், பின்னர் மண்டலத்தையும் அதன் பதிவுகளையும் நீக்குகிறது. பெயர் சேவையகம் இன்னும் மண்டலத்திற்கு பதில் அளித்தால், கோரிக்கை தோல்வியடைகிறது மற்றும் மண்டலம் மீண்டும் முயற்சி செய்யக்கூடிய வகையில் வைத்திருக்கப்படுகிறது.

curl -X DELETE "https://admin.vps.org/api/v1/dns-zones/c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

பதில் நிலை குறியீடுகள்

204 நீக்கப்பட்டது. பதில் உடல் இல்லை.
400 ஒரு பெயர் சேவையகம் இன்னும் இந்த மண்டலத்திற்கு சேவை செய்கிறது. மண்டலம் நீக்கப்படவில்லை; விவர புலத்தில் பிழைகள் பட்டியலிடப்பட்டுள்ளன.
404 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது
பெறு அஞ்சல் /api/v1/dns-zones/{uuid}/records/

ஒரு பகுதியில் பதிவுகளை சேர்க்கவும் அல்லது பட்டியலிடுக

GET, வகை மற்றும் பெயரின்படி வரிசையாக்கப்பட்ட, எல்லையில் உள்ள ஒவ்வொரு பதிவையும் ஒரு வெறும் அட்டவணையாக (பக்கப்படுத்தப்படாத) திரும்பத் தரும். POST, எல்லைக்கு ஒரு பதிவை சேர்த்து அதை வெளியிடும்.

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

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
record_type string ஆம் A, AAAA, CNAME, MX, NS, TXT, SRV, PTR, SOA, CAA
name string ஆம் @ களத்திற்கான, அல்லது www போன்ற ஒரு அடையாளம். பெயர்கள் சிறிய எழுத்துகளில் சேமிக்கப்படும்.
value string ஆம் பதிவு தரவு, உதா. IP முகவரி அல்லது கணினி பெயர். கணினி பெயர்களுக்கு பின்புல புள்ளி தேவையில்லை மற்றும் TXT மதிப்புகளுக்கு மேற்கோள் குறி தேவையில்லை; பதிவு வெளியிடப்படும் போது இரண்டும் சேர்க்கப்படும்.
ttl integer ஆம் நொடிகளில் வாழ்வதற்கு நேரம்
priority integer MX மற்றும் SRV மட்டும் MX மற்றும் SRV பதிவுகளுக்கு தேவையானது மற்ற எல்லா வகைகளுக்கும் புறக்கணிக்கப்படும். SRV க்கு, எடை, துறை மற்றும் இலக்கு மதிப்பிற்குள் வைக்கவும்.

மாதிரி கோரிக்கை

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/dns-zones/c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c/records/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"record_type": "MX", "name": "@", "value": "mail.example.com", "ttl": 3600, "priority": 10}'
import requests

zone_uuid = "c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c"
url = f"https://admin.vps.org/api/v1/dns-zones/{zone_uuid}/records/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
data = {"record_type": "A", "name": "www", "value": "203.0.113.10", "ttl": 3600}

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

எடுத்துக்காட்டு பதில்

{
  "uuid": "9d430082-5562-42b4-a0b2-12a6f6c862f9",
  "record_type": "MX",
  "name": "@",
  "value": "mail.example.com",
  "ttl": 3600,
  "priority": 10,
  "created_at": "2026-09-14"
}

பதில் புலங்கள்

புலங்கள் வகை & விவரக்குறிப்புகள்
uuid string பதிவு அடையாளம், /api/v1/dns-records/ endpoints மூலம் பயன்படுத்தப்பட்டது
priority integer | null MX மற்றும் SRV பதிவுகளுக்கு முன்னுரிமை, இல்லையென்றால் புளூட்
created_at date உருவாக்கும் தேதி மட்டும் (Y- MM- DD), நேரம் இல்லாமல்

பதில் நிலை குறியீடுகள்

200 GET: களத்தின் பதிவுகள்
201 POST: பதிவு உருவாக்கப்பட்டது
400 சரிபார்ப்பு பிழை, உ. த. தெரியாத பதிவு வகை, காணாத ttl, அல்லது முன்னுரிமை இல்லாத MX அல்லது SRV பதிவு
404 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது
அஞ்சல் /api/v1/dns-zones/{uuid}/sync/

ஒரு பகுதியை மறுபதிப்பு செய்

மண்டலத்தையும் அதன் பதிவுகளையும் பெயர் சேவையகங்களுக்கு மீண்டும் நகர்த்துகிறது. பதிவு மாற்றங்கள் தானாகவே வெளியிடப்படும், ஆனால் வெளியிடுதல் சிறந்த முயற்சி மற்றும் தவறு உண்மையான கோரிக்கையை தவறவிடாது, எனவே மாற்றம் DNS தேடலில் தெரியவில்லை என்றால் இதை பயன்படுத்தவும். கோரிக்கை உடல் தேவையில்லை.

curl -X POST "https://admin.vps.org/api/v1/dns-zones/c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c/sync/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "detail": "Zone example.com synced to PowerDNS"
}
பெறு அஞ்சல் /api/v1/dns-records/

பட்டியல் அல்லது களங்களுக்கு இடையே பதிவுகளை உருவாக்கு

GET உங்கள் அனைத்து மண்டலங்களின் பதிவுகளை திரும்பத் தரும், ஒவ்வொரு பக்கத்திற்கும் 25, களம், வகை மற்றும் பெயரின் படி முறைப்படுத்தப்பட்டுள்ளது. POST மண்டல பதிவுகளின் முடிவுப் புள்ளி போன்று ஒரு பதிவை உருவாக்கும், ஆனால் மண்டலத்தின் உடல் zone_ uuid ஆக இருக்கும்.

வினவல் அளவுருக்கள்

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
zone string இல்லை இந்த uuid உடன் மண்டலத்தின் பதிவுகள் மட்டும்
record_type string இல்லை இந்த வகை பதிவுகளை மட்டும், உ. தா. MX (case sensitive)
page integer இல்லை பக்க எண், 1ல் தொடங்குகிறது
curl -X GET "https://admin.vps.org/api/v1/dns-records/?zone=c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c&record_type=A" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

curl -X POST "https://admin.vps.org/api/v1/dns-records/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"zone_uuid": "c7a1e3f0-2b4d-4e6a-9c8b-0d1f2e3a4b5c", "record_type": "TXT", "name": "@", "value": "v=spf1 mx -all", "ttl": 3600}'
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "4b8e2c10-7d3f-4a5b-9e6c-1a2b3c4d5e6f",
      "record_type": "A",
      "name": "www",
      "value": "203.0.113.10",
      "ttl": 3600,
      "priority": null,
      "created_at": "2026-09-14"
    }
  ]
}

பதில் நிலை குறியீடுகள்

200 வெற்றி
201 POST: பதிவு உருவாக்கப்பட்டது
400 சரிபார்ப்பு பிழை, அல்லது zone_ uuid காணவில்லை அல்லது உங்கள் களங்களில் ஒன்று அல்ல
பெறு PUT PATCH நீக்கு /api/v1/dns-records/{uuid}/

பதிவை பெறு, புதுப்பி அல்லது நீக்கு

GET ஒரு பதிவை திரும்பத்தரும். PUT அதை மாற்றுகிறது மற்றும் record_ type, name, value மற்றும் ttl தேவைப்படுகிறது. PATCH நீங்கள் அனுப்பும் புலங்களை மட்டுமே மாற்றுகிறது. DELETE பதிவை நீக்குகிறது மற்றும் உடல் இல்லாமல் 204 திரும்பத்தரும். மாற்றங்கள் உடனடியாக வெளியிடப்படும். NS பதிவுகள் இந்த பகுதியுடன் உருவாக்கப்பட்டவை அமைப்பு பதிவுகள்: அவற்றை புதுப்பித்தல் அல்லது நீக்குதல் 403 திரும்பத்தரும்.

நீங்கள் MX அல்லது SRV பதிவுகளின் முன்னுரிமையை PATCH செய்யும் போது, record_type ஐ அதே கோரிக்கையில் அனுப்பவும். ஒரு PATCH உடல் முன்னுரிமையை கொண்டாலும் record_type இல்லாமல் முன்னுரிமையை நீக்குகிறது.
curl -X PATCH "https://admin.vps.org/api/v1/dns-records/4b8e2c10-7d3f-4a5b-9e6c-1a2b3c4d5e6f/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ttl": 300}'

பதில் நிலை குறியீடுகள்

200 GET, PUT அல்லது PATCH: பதிவு
204 நீக்கப்பட்டது. பதில் உடல் இல்லை.
400 சரிபார்ப்பு பிழை
403 பதிவு ஒரு கணினி பதிவு அல்லது குறிக்கு தேவையான அனுமதி இல்லை
404 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது

பிழை கையாளுதல்

சரிபார்ப்பு பிழைகள் புலப் பெயரால் பெயர் மாற்றப்பட்ட பிரச்சனையுடன் 400 திரும்பும்:

{
  "priority": ["MX records require a priority value"]
}

DNS மாற்றங்களை சோதிக்கவும்

உங்கள் பதிவு பதிவு அல்லது தீர்வு தற்காலிக நினைவகங்கள் பெறுவதற்கு முன் ஒரு மாற்றம் நடக்கும் என்பதை உறுதிப்படுத்த VPS.org பெயர் சேவையகங்களை நேரடியாகக் கேட்கவும்:

dig @ns1.vps.org example.com A
dig @ns2.vps.org example.com MX
dig @ns3.vps.org www.example.com