VPS.org API

وثائق REST API

واجهة برمجة تطبيقات أنظمة التشغيل

قائمة أنظمة التشغيل التي يمكنك تثبيتها وإصداراتها. تمر نسخة uuid كنظام تشغيل نظام إصدار uuid عندما تقوم بإنشاء خادم.

نقاط النهاية 2
المسار الأساسي /api/v1/operating-systems
يحصل /api/v1/operating-systems/

نظم التشغيل

يعيد كل نظام تشغيل مع نسخته النشطة. القائمة لا تحتوي على مرشحات.

الإذن المطلوب: operating-systems:list

مثال على الطلب

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

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

response = requests.get(url, headers=headers)
for os_entry in response.json()["results"]:
    for version in os_entry["versions"]:
        print(os_entry["name"], version["name"], version["uuid"])
const response = await fetch('https://admin.vps.org/api/v1/operating-systems/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
for (const os of data.results) {
  for (const version of os.versions) {
    console.log(os.name, version.name, version.uuid);
  }
}

مثال على الاستجابة

{
  "count": 6,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Ubuntu",
      "svg_icon": "<svg ...>",
      "versions": [
        {
          "uuid": "2fdead8f-81a2-4a23-9a81-0cf969fe1266",
          "name": "22.04 LTS x64",
          "os_name": "Ubuntu",
          "os_svg_icon": "<svg ...>",
          "is_active": true
        },
        {
          "uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
          "name": "24.04 LTS x64",
          "os_name": "Ubuntu",
          "os_svg_icon": "<svg ...>",
          "is_active": true
        }
      ]
    }
  ]
}

اختصار: يظهر نظام تشغيل واحد فقط ويتم قطع علامة SVG.

حقول الاستجابة

الميدان يكتب وصف المشروع
id integer تعريف نظام التشغيل
name string اسم التوزيع، مثل أوبونتو أو ديبان
svg_icon string علامات SVG داخلية للشعار (ليس عنوان URL)
versions array النسخ النشطة التي يمكنك تثبيتها
versions[].uuid string استخدام كنظام تشغيل نسخة uuid عند إنشاء خادم
versions[].name string النسخة والبنية، مثل 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string اسم نظام التشغيل الأصلي ورمزه
versions[].is_active boolean ما إذا كان يمكن استخدام النسخة في الخوادم الجديدة

رموز حالة الاستجابة

200 قائمة نظم التشغيل المسترجعة بنجاح
403 رمز API مفقود أو غير صحيح، أو يفتقر الرمز إلى الإذن المطلوب
يحصل /api/v1/operating-systems/{id}/

الحصول على نظام تشغيل

يعيد نظام تشغيل واحد وإصداراته النشطة، مع الحقول أعلاه.

curl -X GET "https://admin.vps.org/api/v1/operating-systems/1/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

رموز حالة الاستجابة

200 النجاح
404 لا يوجد نظام تشغيل بهذا الرمز

اختيار نسخة

البحث عن الإصدارات من خلال الاسم في وقت التنفيذ بدلا من الترميز الجسيم uuid، لذلك تكاملك يظل يعمل عندما الإصدارات هي أضيفت أو سحب. root تفاصيل الدخول يتم إرسالها إلى مالك الحساب بمجرد أن الخادم جاهز؛ أضف مفتاح SSH عند إنشاء الخادم للدخول مع مفتاح بدلا من ذلك.