VPS.org API

REST API دستاویزی

پلانز API

سرور پلانوں کی فهرست آپ ان کے وسائل اور قیمتوں کے ساتھ نشر کر سکتے ہیں. جب آپ سرور بناتے ہیں یا اس کی سائز بدلتے ہیں تو ایک پلان کے uuid کو plan_uuid کے طور پر منتقل کریں.

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

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

ہر فعال منصوبہ واپس کرتا ہے، سب سے کم قیمتی پہلے. فہرست میں کوئی فلٹر نہیں ہے اور اب ایک صفحے پر فٹ ہوتا ہے.

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

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

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

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

response = requests.get(url, headers=headers)
for plan in response.json()["results"]:
    print(plan["uuid"], plan["cpu"], plan["ram"], plan["ram_unit"], plan["monthly_price"])
const response = await fetch('https://admin.vps.org/api/v1/plans/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);
$ch = curl_init('https://admin.vps.org/api/v1/plans/');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_API_TOKEN']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$plans = json_decode(curl_exec($ch), true);
curl_close($ch);

مثال کا جواب

{
  "count": 12,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "ed0ac717-c26c-4d9b-a801-b170c4979028",
      "cpu": 1,
      "ram": 512,
      "ram_unit": "MB",
      "disk_space": 10,
      "disk_space_total": 10240,
      "transfer": 500,
      "transfer_unit": "GB",
      "includes_ipv4": false,
      "price": "2.50",
      "cpu_type_name": "Shared",
      "is_active": true,
      "hourly_price": "0.004",
      "monthly_price": "2.50",
      "is_gpu": false,
      "gpu_count": 0,
      "gpu_model": ""
    },
    {
      "uuid": "14186969-fbaf-43e1-9ab2-b1f1aeb66674",
      "cpu": 1,
      "ram": 2,
      "ram_unit": "GB",
      "disk_space": 25,
      "disk_space_total": 25600,
      "transfer": 1,
      "transfer_unit": "TB",
      "includes_ipv4": true,
      "price": "5.00",
      "cpu_type_name": "Shared",
      "is_active": true,
      "hourly_price": "0.007",
      "monthly_price": "5.00",
      "is_gpu": false,
      "gpu_count": 0,
      "gpu_model": ""
    }
  ]
}

رسپانس فیلڈز

شعبہ قسم وضاحت
uuid string پلان شناخت. اسے plan_uuid یا new_plan_uuid کے طور پر استعمال کریں.
cpu integer تعداد
ram, ram_unit integer, string یادداشت کی مقدار اور اس کی واحد (MB یا GB)
disk_space integer ڈسک کی سائز GB میں
disk_space_total integer ڈسک کی سائز MB میں
transfer, transfer_unit integer, string ماہانہ ڈیٹا ٹرانسپورٹ وقفہ اور اس کی یونٹی (GB یا TB)
disk_space_unit string ڈسک کی جگہ کی یونٹی (GB)
includes_ipv4 boolean اگر پلان میں ایک عوامی IPv4 پتہ شامل ہے تو. ایک کے بغیر پلان صرف IPv6 ہیں. ایک IPv4 پتہ $2.00/مئی کے لیے شامل کیا جاسکتا ہے.
monthly_price, price string ایک اعشاری سٹرنڈ کے طور پر USD میں ماہانہ قیمت. قیمت ایک ہی قدر ہے.
hourly_price string ایک اعشاری سٹرنڈ کے طور پر USD میں گھنٹہ کی قیمت
cpu_type_name string سی پی یو قسم، مثال کے طور پر مشترکہ. بی سی پی یو قسم کے پلان کے لیے چھوڑ دیا گیا، جی پی یو پلان کی طرح.
is_active boolean اس فہرست میں ہمیشہ صحیح، کیونکہ غیر فعال منصوبے واپس نہیں کیے جاتے
is_gpu, gpu_count, gpu_model boolean, integer, string اگر منصوبہ میں مخصوص GPUs شامل ہیں، کتنے اور کون سا ماڈل
جواب میں یہ نہیں کہا گیا کہ ایک منصوبہ میں ایک IPv4 پتہ شامل ہے یا نہیں. 512 MB پلان صرف IPv6 ہے; باقی جاری منصوبوں میں IPv4 شامل ہے. ایک سائٹ کے لئے منصوبہ منتخب کرنے سے پہلے قیمتوں کے صفحے سے موازنہ کریں جو IPv4 پر رسائی کے قابل ہونا چاہیے.

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

200 پلان فہرست کامیابی سے واپس کی گئی
403 غائب یا غیر معتبر API ٹوکن، یا توکن میں ضروری اجازت نامہ نہیں ہے
حاصل کریں۔ /api/v1/plans/{uuid}/

پلان کی تفصیلات حاصل کریں۔

اوپر کے فیلڈز کے ساتھ ایک فعال منصوبہ واپس کرتا ہے. ایک غیر فعال یا نامعلوم uuid 404 واپس کرتا ہے.

curl -X GET "https://admin.vps.org/api/v1/plans/ed0ac717-c26c-4d9b-a801-b170c4979028/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "uuid": "ed0ac717-c26c-4d9b-a801-b170c4979028",
  "cpu": 1,
  "ram": 512,
  "ram_unit": "MB",
  "disk_space": 10,
  "disk_space_total": 10240,
  "transfer": 500,
  "transfer_unit": "GB",
  "includes_ipv4": false,
  "price": "2.50",
  "cpu_type_name": "Shared",
  "is_active": true,
  "hourly_price": "0.004",
  "monthly_price": "2.50",
  "is_gpu": false,
  "gpu_count": 0,
  "gpu_model": ""
}