VPS.org API

REST API Documentation

رابط برنامه‌نویسی کاربردی (API) سیستم‌های عامل

فهرست سیستم عامل‌هایی که می‌توانید نصب کنید و نسخه‌های آن‌ها را نمایش می‌دهد. هنگامی که کارگزار را ایجاد می‌کنید، uuid نسخه را به عنوان operating_system_version_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 قطع می‌شود.

فیلدهای پاسخ

میدان نوع Description
id integer شناسۀ سیستم‌عامل
name string نام توزیع، برای مثال Ubuntu یا Debian
svg_icon string علامت‌گذاری SVG خطی نشانه) نه نشانی وب (
versions array نسخه‌های فعال که می‌توانید نصب کنید
versions[].uuid string هنگام ایجاد کارگزار به عنوان uuid_version_operating_system استفاده شود
versions[].name string Version and architecture, for example 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 ، نسخه‌ها را بر اساس نام جستجو کنید ، بنابراین ادغام شما هنگام اضافه کردن یا حذف نسخه‌ها همچنان کار می‌کند. جزئیات ورود ریشه هنگامی که کارساز آماده است به صاحب حساب ارسال می‌شود. هنگام ایجاد کارساز ، برای ورود با کلید ، یک کلید SSH اضافه کنید.