VPS.org API

Dokumentácia REST API

API operačných systémov

Pri vytváraní servera odovzdajte uuid verzie ako operating_system_version_uuid, aby ste mohli inštalovať operačné systémy a ich verzie.

Koncové body 2
Základná cesta /api/v1/operating-systems
ZÍSKAŤ /api/v1/operating-systems/

Zoznam operačných systémov

Vráti každý operačný systém s jeho aktívnymi verziami. Zoznam nemá žiadne filtre.

Požadované povolenie: operating-systems:list

Príklad žiadosti

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

Príklad odpovede

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

Skrátené: zobrazí sa len jeden operačný systém a SVG značky sú skrátené.

Polia odpovede

Pole Typ Opis
id integer Identifikátor operačného systému
name string Názov distribúcie, napríklad Ubuntu alebo Debian
svg_icon string Inline SVG značka loga (nie URL)
versions array Aktívne verzie, ktoré môžete nainštalovať
versions[].uuid string Použiť ako operačný systém_verzia_uuid pri vytváraní servera
versions[].name string Verziarchitektúra, napríklad 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Názov a ikona nadradeného operačného systému
versions[].is_active boolean Či sa dá táto verzia použiť pre nové servery

Kódy stavu odpovede

200 Zoznam úspešne načítaných operačných systémov
403 Chýbajúci alebo neplatný token API alebo token nemá požadované povolenie
ZÍSKAŤ /api/v1/operating-systems/{id}/

Získanie operačného systému

Vráti jeden operačný systém a jeho aktívne verzie s poľami vyššie.

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

Kódy stavu odpovede

200 Úspech
404 Žiadny operačný systém s týmto ID

Výber verzie

Vyhľadávanie verzií podľa názvu v runtime namiesto hardkódovania uuid, takže vaša integrácia bude fungovať aj po pridaní alebo odstránení verzií. Prihlasovacie údaje root sú odoslané e-mailom vlastníkovi účtu, keď je server pripravený. Pri vytváraní servera pridajte SSH kľúč, aby ste sa namiesto toho prihlásili pomocou kľúča.