VPS.org API

وثائق REST API

واجهة برمجة تطبيقات المواقع

قائمة المواقع حيث يمكنك نشر VPS. مرر موقع هوية ك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}/

احصل على موقع

استرجاع موقع واحد من خلال رمزه. الاستجابة هي كائن موقع واحد مع الحقول أعلاه.

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. دائما قراءة المواقع نقطة نهاية بدلا من رمز تعريف، لذا تكاملك يأخذ المواقع الجديدة عندما يتم إضافتها.