VPS.org API دستاویزی

شروع کرنا

VPS.org API آپ کو اپنے VPS ہوسٹنگ انفراسٹرکچر کے تمام پہلوؤں کا نظم کرنے کی اجازت دیتا ہے، بشمول سرورز، ڈومینز، DNS ریکارڈز، بیک اپ اور سنیپ شاٹس۔

تصدیق

تمام API درخواستوں کو بیئرر ٹوکن کا استعمال کرتے ہوئے تصدیق کی ضرورت ہوتی ہے۔ آپ اپنے اکاؤنٹ کی ترتیبات سے اپنا API ٹوکن بنا سکتے ہیں۔ admin.vps.org/account/developers/.

curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

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

ہر ٹوکن اپنے آپ کے اجازت نامے لے جاتا ہے، جیسے سرور:لیسٹ یا dns:*. ایک درخواست جس کو اجازت نامہ کی ضرورت ہوتی ہے توکن کے پاس نہیں ہے 403 اور ایک required_permission فیلڈ کے ساتھ رد کی جاتی ہے جس میں غائب اجازت نامے کا نام ہوتا ہے. اجازتیں

شرح کی حد بندی

توثیق شدہ درخواستیں ہر ایک اکاؤنٹ کے لیے ہر گھنٹہ 1000 تک محدود ہیں. غیر توثیق شدہ درخواستیں ہر ایک IP پتہ کے لیے ہر ایک گھنٹہ 100 تک محدود ہیں. حد سے زائد درخواست 429 حاصل کرتی ہے جس میں ایک Retry-After ہیڈر شامل ہے جو انتظار کے سیکنڈ کی تعداد دیتا ہے. کوئی ریت حد ہیڈر کامیاب جوابوں پر بھیجا جاتا ہے.

صفحہ بند

فہرست سرا ں پا ئنٹ گي تعداد ، بعدي ، سابق اور نتيجے کے ساتھ ایک او عيٹ واپس کر تا هے ، 25 ايٹم پر صفحہ صفحات کے درمیان منتقل کر نے کے ليے صفحہ پاس کريں يا بعدي URL کو پيرو ں جب تک وہ خالي نہ ہو سر ورز فہرست page_size کو بھی قبول کر تا هے ، 100 تک

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

ایرر ہینڈلنگ

API کامیابی یا ناکامی کی نشاندہی کرنے کے لیے معیاری HTTP اسٹیٹس کوڈ استعمال کرتا ہے:

غلطی کے جسم JSON ہیں. اکثر میں تفصیلی فیلڈ یا غلطی کے فیلڈ ہیں، کبھی کبھی پیغام کے ساتھ؛ تصدیق کی غلطیاں فیلڈ نام کے مطابق مسائل کی فہرست کرتے ہیں.

API زمرہ جات

زمرہ کے لحاظ سے ہماری API دستاویزات کو براؤز کریں:

مزید انتہا پوائنٹس

API میں ایپ ڈیبلےمنٹ کے لیے بھی انتہا پوائنٹ ہیں (/api/v1/deploy-configs/ اور /api/v1/deployments/). ان کو اب تک ان صفحات پر بیان نہیں کیا گیا ہے؛ تعاملی حوالہ ہر انتہا پوائنٹ کی فهرست، لائیو API سے پیدا کیا گیا ہے.

مدد کی ضرورت ہے؟

اگر آپ کے سوالات ہیں یا API کے ساتھ مدد کی ضرورت ہے، تو براہ کرم رابطہ کرنے میں ہچکچاہٹ محسوس نہ کریں:

• سپورٹ ٹکٹس: سپورٹ ٹکٹ کھولیں۔
• ای میل: hello@vps.org
• دستاویزی: مکمل دستاویزات