VPS.org API

REST API ডকুমেন্টেশন

ডিএনএস ম্যানেজমেন্ট এপিআই

আপনার ডোমেনের জন্য প্রোগ্রাম্যাটিকভাবে DNS জোন এবং রেকর্ড পরিচালনা করুন।

শেষবিন্দু ৪টি শেষ বিন্দু
বেস পাথ /api/v1/dns-zones
প্রমাণীকরণ বহনকারী টোকেন আবশ্যক

সংক্ষিপ্ত বিবরণ

DNS API DNS অঞ্চল এবং রেকর্ডের পূর্ণ ব্যবস্থাপনা প্রদান করে। সমস্ত অঞ্চল স্বয়ংক্রিয় BIND9 অঞ্চল ফাইল উৎপাদন এবং প্রসারণের সাথে VPS.org এর কর্তৃত্বপূর্ণ নাম সার্ভারে হোস্ট করা হয়।

নেম সার্ভারের পরিকাঠামো

প্রধান বৈশিষ্ট্য

প্রমাণীকরণ

সকল 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 অঞ্চল সম্পর্কে বিস্তারিত তথ্য উদ্ধার করুন, সব রেকর্ড সহ।

পথের পরামিতি

পরামিতি আদর্শ প্রয়োজনীয় বর্ণনা
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/

ডি. এন. এস. জোন তৈরি করো

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}/

ডি. এন. এস. জোন মুছে ফেলো

একটি ডি. এন. এস. জোন এবং সব সংশ্লিষ্ট রেকর্ড স্থায়ীভাবে মুছে ফেলো । এই কাজটি বাতিল করা যাবে না ।

পথের পরামিতি

পরামিতি আদর্শ প্রয়োজনীয় বর্ণনা
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/

ডি. এন. এস. রেকর্ড তৈরি করো

একটি নির্দিষ্ট অঞ্চলে (নেস্টেড রাউট) একটি নতুন ডি. এন. এস. রেকর্ড যোগ করো ।

অনুরোধ বডি প্যারামিটার

পরামিতি আদর্শ প্রয়োজনীয় বর্ণনা
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"
}

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

অনলাইন টুল ব্যবহার করা হচ্ছে