VPS.org API

REST API ලේඛන

DNS කළමනාකරණ API

ඔබගේ වසම් සඳහා DNS කලාප සහ වාර්තා ක්‍රමලේඛනගතව කළමනාකරණය කරන්න.

අන්ත ලක්ෂ්‍ය අන්ත ලක්ෂ්‍ය 4ක්
පාදක මාර්ගය /api/v1/dns-zones
සත්‍යාපනය ධාරක ටොකනය අවශ්යයි

දළ විශ්ලේෂණය

DNS API DNS කලාප හා වාර්තා සම්පූර්ණ කළමනාකරණය සපයයි. සියලු කලාප ස්වයංක්රීය BIND9 කලාප ගොනු ජනනය සහ යෙදවීම සමග VPS.org ගේ බලයලත් නාම සර්වර මත සත්කාරකත්වය සපයයි.

නාමසර්වර යටිතල පහසුකම්

ප්රධාන විශේෂාංග

සත්‍යාපනය

සියලු DNS API ඉල්ලීම් දරන්නා ටෝකන් සහතික කිරීම අවශ්ය. ඔබේ ගිණුම දර්ශක පුවරුව සිට API ටෝකන් ජනනය /account/developers/ පහත සඳහන් අවසර සමඟ:

උදාහරණය

Authorization: Bearer vps_abc123def456...
වැදගත්: API ටොකන් නිර්මාණය අතරතුර එක් වරක් පමණක් පෙන්වයි. ආරක්ෂිතව ගබඩා. ඔබ ටොකන් අහිමි නම්, ඔබ නව එකක් ජනනය කළ යුතුය.
ලබා ගන්න /api/v1/dns-zones/

සියලුම DNS කලාප ලැයිස්තුගත කරන්න

සියලු DNS කලාප හිමි සත්යාපනය පරිශීලක විසින් paginated ලැයිස්තුවක් ලබා ගන්න. ඩොමේන් නාමය විසින් පෙරහන් සහාය.

විමසුම් පරාමිතීන්

පරාමිතීන් වර්ගය අවශ්‍යයි විස්තරය
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 කලාපය නිර්මාණය කරන්න

ඩොමේනයක් සඳහා නව 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 වාර්තා ලැයිස්තුගත කරන්න

විශේෂිත කලාපයක් සඳහා සියලු 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 වාර්තාවක් නිර්මාණය කරන්න

විශේෂිත කලාපයක් (නිදන්ගත මාර්ගය) නව 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 වාර්තා කළමනාකරණය (සෘජු ප්රවේශය)

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

මාර්ගගත මෙවලම් භාවිතා කිරීම