VPS.org API

REST API دستاویزی

ڈومینز API

دستیاب ڈومین ناموں کے لیے تلاش کریں، ڈومینوں کو رجسٹر اور نئے کریں، اور ان کے نام سرور اور خودکار نئے کرنے کا انتظام کریں۔ ڈومینوں کی شناخت ان کے uuid سے کی جاتی ہے۔

اینڈ پوائنٹس 7
بنیاد کا راستہ /api/v1/domains
حاصل کریں۔ /api/v1/domains/

تمام ڈومینز کی فہرست بنائیں

آپ کے اکاؤنٹ میں رجسٹرڈ ڈومینز واپس کرتا ہے، ہر صفحے پر 25۔ اس فہرست میں کوئی فلٹر نہیں ہے۔

اجازت لازم ہے: domains:list

مثال کی درخواست

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/domains/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/domains/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for domain in response.json()["results"]:
    print(domain["domain_name"], domain["status"], domain["expiration_date"])
const response = await fetch('https://admin.vps.org/api/v1/domains/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

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

مثال کا جواب

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
      "domain_name": "example.com",
      "status": "active",
      "registrar": "dynadot",
      "registration_date": "2026-01-15T10:30:00Z",
      "expiration_date": "2027-01-15T10:30:00Z",
      "days_until_expiration": 122,
      "is_expired": false,
      "needs_renewal_soon": false,
      "auto_renew": true,
      "renewal_period_years": 1,
      "registration_price": "12.64",
      "renewal_price": "12.64",
      "whois_privacy": true,
      "nameserver1": "ns1.vps.org",
      "nameserver2": "ns2.vps.org",
      "nameserver3": "ns3.vps.org",
      "nameserver4": null,
      "transfer_lock": true,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-09-01T08:12:40Z"
    }
  ]
}

رسپانس فیلڈز

شعبہ قسم وضاحت
uuid string دوسرے ڈومین انتہا پوائنٹس میں استعمال شدہ ڈومین شناخت
status string active, pending, expired, cancelled, transferred
registrar string رجسٹرار ڈومین یہاں رکھا جاتا ہے
registration_date, expiration_date datetime جب ڈومین رجسٹر کیا گیا تھا اور جب یہ ختم ہوتا ہے. ختم ہونے کا تاریخہ خالی ہو سکتا ہے.
days_until_expiration integer | null ختم ہونے کی_تاریخ تک پورے دن، ایک بار ختم ہونے پر منفی
is_expired, needs_renewal_soon boolean اگر ڈومین ختم ہو گیا ہے اور اگر یہ بعد ازاں 30 دن کے اندر ختم ہو جاتا ہے
auto_renew, renewal_period_years boolean, integer اگر ڈومین خودکار طور پر تجدید کرتا ہے اور کتنے سال کے لیے
registration_price, renewal_price string قیمتیں USD میں اعشاری سٹرینڈز کے طور پر
whois_privacy, transfer_lock boolean WHOIS پرائیویٹی اور رجسٹرار ٹرانسپورٹ لاگ ترتیبات
nameserver1 to nameserver4 string | null ڈومین کے نام سرور
created_at, updated_at datetime ریکارڈ جب بنایا گیا اور آخری بار تبدیل کیا گیا (ISO 8601، UTC)
حاصل کریں۔ /api/v1/domains/{uuid}/

ڈومین تفصیلات حاصل کریں

اوپر کے شعبوں کے ساتھ ایک ڈومین چیز واپس کرتا ہے.

اجازت لازم ہے: domains:list

curl -X GET "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

رسپانس اسٹیٹس کوڈز

200 کامیابی
404 نہیں ملا یا یہ دوسرے اکاؤنٹ کی ملکیت تھا
پوسٹ /api/v1/domains/search/

ڈومین دستیابی تلاش کریں

اگر نام 20 سے زائد مشہور توسیعوں (com، net، org، io، dev، co، app، ai اور مزید) پر دستیاب ہے تو اس کا جائزہ لیتا ہے، اور اگر آپ نے ٹائپ کیا ہے تو اس کی اضافی اگر وہ ان میں سے نہیں ہے تو اس کا جائزہ لیتا ہے. نتائج صحیح مطابقت سے شروع ہوتے ہیں، پھر دستیاب نام، پھر لے لیے نام.

اجازت لازم ہے: domains:search

جسمانی پیرامیٹرز کی درخواست کریں۔

پرائمری قسم درکار ہے۔ وضاحت
domain string جی ہاں ایک نام جس میں یا جس میں کوئی توسیع نہیں ہے، مثال کے طور پر mysite یا mysite.com (2 سے 63 حروف)

مثال کی درخواست

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/domains/search/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "mysite.com"}'
import requests

url = "https://admin.vps.org/api/v1/domains/search/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers, json={"domain": "mysite.com"})
for result in response.json()["results"]:
    if result["available"]:
        print(result["domain"], result["registration_price"], result["renewal_price"])

مثال کا جواب

{
  "results": [
    {
      "domain": "mysite.com",
      "available": false,
      "price": null,
      "registration_price": null,
      "renewal_price": null,
      "tld": "com",
      "is_exact_match": true
    },
    {
      "domain": "mysite.dev",
      "available": true,
      "price": 17.24,
      "registration_price": 17.24,
      "renewal_price": 17.24,
      "tld": "dev",
      "is_exact_match": false
    }
  ],
  "base_domain": "mysite",
  "search_count": 20
}

قیمتیں ایک سال کے لئے امریکی ڈالر میں اعداد ہیں اور ناموں کے لئے صفر ہیں جو دستیاب نہیں ہیں۔ قیمتیں دکھائی جاتی ہیں

رسپانس اسٹیٹس کوڈز

200 کامیابی
400 کھویا گیا ڈومین، یا اس میں حروف، اعداد اور ہائبن کے علاوہ دیگر حروف موجود ہیں
500 رجسٹرر لوک فشل ہوا. بعد میں دوبارہ کوشش کرو.
پوسٹ /api/v1/domains/register/

نیا ڈومین رجسٹر کریں۔

ایک ڈومین رجسٹر کرتا ہے اور آپ کے محفوظ کیے گئے ادائگی کے طریقے کو چارج کرتا ہے. دستیابی اور قیمت چارج کرنے سے پہلے رجسٹرار کے ساتھ دوبارہ چکی جاتی ہے. رجسٹرنٹ رابطہ کی تفصیلات آپ کے اکاؤنٹ سے لی جاتی ہیں. اگر رجسٹرار چارج کرنے کے بعد رجسٹریشن کو رد کر دیتا ہے تو ادائگی واپس کر دی جاتی ہے.

اجازت لازم ہے: domains:register (ڈومینز کے ذریعے دیے گئے:*)

جسمانی پیرامیٹرز کی درخواست کریں۔

پرائمری قسم درکار ہے۔ وضاحت
domain string جی ہاں مکمل ڈومین نام اس کی توسیع سمیت، مثال example.com
years integer نہیں رجسٽريشن دور، 1 سے 10 (دفٹر 1) قيمت سالانہ قيمت سالوں کے وقت ہے.ai کو کم از کم 2 سال ضرورت هے ، کم قيمت 400 واپس کر تا هے 
curl -X POST "https://admin.vps.org/api/v1/domains/register/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "mysite.dev", "years": 1}'

مثال کا جواب

{
  "success": true,
  "domain_uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
  "domain_name": "mysite.dev",
  "message": "mysite.dev registered successfully!"
}

رسپانس اسٹیٹس کوڈز

201 ڈومین رجسٹر کیا گیا
400 نامعقول ڈومین، ڈومین اب دستیاب نہیں ہے، قیمت تصدیق نہیں کی جاسکتی، پرانا ادائیگی کا طریقہ یا ادائیگی ناکام ہوئی
402 فائلیں پر کوئی ادائیگی کا طریقہ نہیں ہے، یا غیر ادا کیے گئے بل
500 ادائگی کو پروسیسنگ نہیں کیا جاسکتا، یا رجسٹرار نے ادائگی کے بعد رجسٹریشن کو رد کر دیا ہے۔ دوسرے معاملے میں غلطی کا پیغام بتاتا ہے کہ آیا واپسی گزر گئی ہے۔
پوسٹ /api/v1/domains/{uuid}/renew/

ڈومین

ڈومین کو تجدید کرتا ہے اور ہر سال کے لیے اس کی تجدید_قیمت کو آپ کے محفوظ پرداخت کے طریقے کے لیے چارج کرتا ہے۔

اجازت لازم ہے: domains:renew

جسمانی پیرامیٹرز کی درخواست کریں۔

پرائمری قسم درکار ہے۔ وضاحت
years integer نہیں سال جمع کرنے کے لیے، 1 سے 10 (دفٹر 1) 
curl -X POST "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/renew/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"years": 1}'
{
  "success": true,
  "domain_uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
  "new_expiration": "2028-01-15T10:30:00+00:00",
  "message": "example.com renewed successfully for 1 year(s)!"
}

رسپانس اسٹیٹس کوڈز

200 ڈومین تجدید کیا گیا
400 نامعقول سال، ڈومین کے لیے کوئی تجدید قیمت نہیں، کوئی استعمال شدہ ادائیگی کا طریقہ نہیں، یا ادائیگی ناکام ہوئی
404 نہیں ملا یا یہ دوسرے اکاؤنٹ کی ملکیت تھا
500 ادائگی کو پروسیسنگ نہیں کیا جاسکتا، یا ادائگی گزر گئی لیکن رجسٹرار کی تجدید ناکام ہوئی. اس صورت میں مدد سے رابطہ کریں.
PUT /api/v1/domains/{uuid}/nameservers/

نام سرور

رجسٹرار پر ڈومین کے نام سرور قائم کرتا ہے اور اپڈیٹڈ ڈومین اوبجیکٹ واپس کرتا ہے. DNS API کے ساتھ DNS کو انتظام کرنے کے لیے، ns1.vps.org، ns2.vps.org اور ns3.vps.org استعمال کریں اور ڈومین کے لیے ایک زون بنائیں.

اجازت لازم ہے: domains:update

جسمانی پیرامیٹرز کی درخواست کریں۔

پرائمری قسم درکار ہے۔ وضاحت
nameserver1 string جی ہاں پرائمری نام سرور ہوسٹ نام
nameserver2, nameserver3, nameserver4 string نہیں اضافی نام سرور ہوسٹ نام 
curl -X PUT "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/nameservers/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"nameserver1": "ns1.vps.org", "nameserver2": "ns2.vps.org", "nameserver3": "ns3.vps.org"}'

رسپانس اسٹیٹس کوڈز

200 نام سرور اپڈیٹ؛ باڈی ڈومین اوبجیکٹ ہے
400 نام سرور1 غائب ہے
404 نہیں ملا یا یہ دوسرے اکاؤنٹ کی ملکیت تھا
500 اپڈیٹ ناکام ہوگیا؛ باڈی میں غلطی اور پیغام کے فیلڈ ہیں
PUT /api/v1/domains/{uuid}/auto-renew/

خودکار تجدید کو فعال یا غیر فعال کریں

auto_renew کو مقرر کرتا ہے اور اپڈیٹڈ ڈومین اوبجیکٹ واپس کرتا ہے.JSON بولین کے طور پر فعال بھیجنا:کوئی بھی خالی نہیں سٹر، اس میں سٹر غلط بھی شامل ہے، خودکار تجدید کو روشن کرتا ہے.

اجازت لازم ہے: domains:update

curl -X PUT "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/auto-renew/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

رسپانس اسٹیٹس کوڈز

200 ترتیب محفوظ کی گئی؛ باڈی ڈومین اوبجیکٹ ہے
400 فعال گم
404 نہیں ملا یا یہ دوسرے اکاؤنٹ کی ملکیت تھا

یادداشتیں