VPS.org API

REST API sənədləşdirilməsi

Əməliyyat Sistemləri API-si

Quraşdıra biləcəyiniz əməliyyat sistemləri və onların versiyalarını göstər. Versiya uuid-ini verici yaratdığınız zaman operating_system_version_uuid olaraq keçin.

Son Nöqtələr 2
Əsas Yol /api/v1/operating-systems
AL /api/v1/operating-systems/

İşləyiş sistemləri siyahısı

Hər bir əməliyyat sistemini aktiv versiyaları ilə geri qaytarır. Siyahıda filtr yoxdur.

İcazə tələb olunur: operating-systems:list

Nümunə Sorğu

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);
  }
}

Nümunə Cavab

{
  "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
        }
      ]
    }
  ]
}

Kısa: yalnız bir əməliyyat sistemi göstərilir və SVG mətni kəsilir.

Cavab Sahələri

Sahə Növü İzahat
id integer İşləyiş sistemi identifikatoru
name string Yayımın adı, məsələn Ubuntu və ya Debian
svg_icon string Logonun daxili SVG mətni (URL deyil)
versions array Qura biləcəyiniz aktiv versiyalar
versions[].uuid string Verici yaradılarkən operating_system_version_uuid olaraq istifadə et
versions[].name string Versiya və arxitektura, misal üçün 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Ana əməliyyat sisteminin adı və timsalı
versions[].is_active boolean Versiya yeni vericilər üçün istifadə edilə bilər

Cavab Status Kodları

200 Müvəffəqiyyətlə alınan əməliyyat sistemləri siyahısı
403 API tokeni yoxdu ya da səhvdir, ya da tokenin lazımi icazəsi yoxdur
AL /api/v1/operating-systems/{id}/

İşləyiş sistemini əldə et

Üst sahələri ilə bir əməliyyat sistemini və onun aktiv versiyalarını geri qaytarır.

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

Cavab Status Kodları

200 Müvəffəqiyyət
404 Bu id-li əməliyyat sistemi yoxdur

Versiya seçilir

uuid-i hardkodlamaq əvəzinə işə salma vaxtında versiyaları adla axtar, beləliklə də versiyalar əlavə edildikdə və ya işdən çıxarıldıqda inteqrasiyanız işləməyə davam edəcəkdir. Verici hazır olduqda kök giriş məlumatları hesab sahibinə e-poçtla göndəriləcəkdir; verici yaradılarkən SSH açarı əlavə et ki, açarla daxil olasan.