VPS.org API

REST API دستاویزی

مقامات API

ان جگہوں کی فهرست جس میں آپ VPS کو استعمال کرسکتے ہیں. ایک جگہ کے id کو location_id کے طور پر منتقل کریں جب آپ سرور بناتے ہیں.

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

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

تمام دستیاب ڈیٹا سینٹر کی جگہوں کی فہرست حاصل کریں جہاں آپ VPS سروروں کو نشر کرسکتے ہیں.

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

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

url = "https://admin.vps.org/api/v1/locations/"
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/locations/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

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

$response = curl_exec($ch);
$locations = json_decode($response, true);
curl_close($ch);

مثال کا جواب

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "New Jersey",
      "country_name": "United States",
      "country_code": "US",
      "is_active": true
    }
  ]
}

رسپانس فیلڈز

شعبہ قسم وضاحت
id integer جگہ کی شناخت. اسے location_id کے طور پر استعمال کریں جب سرور بنایا جاتا ہے.
name string انسانی پڑھنے کے قابل مقام کا نام
country_name string مقام کا ملک
country_code string ISO 3166-1 alpha-2 ملک کوڈ، بڑے حروف
is_active boolean کیا جگہ نئے سرور قبول کرتی ہے

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

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

مقام حاصل کریں

ایک جگہ کو اسکے id کے ذریعے واپس کريں جواب اوپر کے فائل کے ساتھ ایک جگہ کا عائد هے

curl -X GET "https://admin.vps.org/api/v1/locations/1/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": 1,
  "name": "New Jersey",
  "country_name": "United States",
  "country_code": "US",
  "is_active": true
}

جہاں آپ کے سرور چلتے ہیں

ہر VPS.org سرور اب ہماری نیو جرسی، امریکا کی جگہ پر چلتا ہے، جو IPv4 اور IPv6 پر دنیا بھر کے کلائنٹس کو خدمت کرتا ہے. ہمیشہ جگہوں کے انتہا پوائنٹ کو پڑھتے ہیں نہ کہ ایک id کو ہارڈ کوڈ کرتے ہیں، تو آپ کا انٹیگریشن جب وہ شامل ہوتے ہیں تو نئے مقامات کو پکڑتا ہے.