VPS.org API

REST API لاسوندونه

د DNS مدیریت API

د خپلو ډومینونو لپاره د DNS زونونه او ریکارډونه په پروګراماتي ډول اداره کړئ.

د پای ټکي ۴ پای ټکي
بنسټیزه لاره /api/v1/dns-zones
اعتبار د لېږونکي توکي اړين دي

عمومي کتنه

د DNS API د DNS زونونو او ریکارډونو بشپړ مدیریت چمتو کوي. ټول زونونه د VPS.org د معتبر نوم سرور سره د اتوماتیک BIND9 زون فایل نسل او پلي کولو سره کوربه کیږي.

نوم پالنګر بنسټيزه جوړښت

ځانګړتياوې

اعتبار

د DNS API غوښتنې د بارر ټوکن تصدیق ته اړتیا لري. د خپل حساب ډیش بورډ څخه د API ټوکنونه رامینځته کړئ /account/developers/ :د لاندې پرېښلو سره

بېلګه

Authorization: Bearer vps_abc123def456...
:مهم API توکي د جوړولو په ترڅ کې يوازې يو ځل ښودل شوي. خوندي یې وساتئ. که تاسو یو توکي له لاسه ورکړئ، نو تاسو باید یو نوی تولید کړئ.
ترلاسه کړئ /api/v1/dns-zones/

د ټولو DNS زونونو لیست وکړئ

د ټولو د DNS زونونو د حقیقي کارن لخوا د ملکیت یو pageted لیست ترلاسه کړئ. د ډومین نوم لخوا چاڼ ملاتړ کوي.

د پوښتنې پیرامیټرې

پېرامېټر ډول اړین دی سپړاوی
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

د ډومین لپاره نوی 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 ریکارډونه اداره کړئ (مستقیم لاسرسی)

د ریکارډ 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

په کارولو سره آنلاین توکي