VPS.org API

Dokumentacja REST API

API systemów operacyjnych

Wyświetla systemy operacyjne, które możesz zainstalować i ich wersje. Przekaż uuid wersji jako operator_ system_ version_ uuid podczas tworzenia serwera.

Punkty końcowe 2
Ścieżka bazowa /api/v1/operating-systems
DOSTAWAĆ /api/v1/operating-systems/

Wykaz systemów operacyjnych

Zwraca każdy system operacyjny z aktywnymi wersjami. Lista nie ma filtrów.

Wymagane zezwolenie: operating-systems:list

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Skracony: pokazany jest tylko jeden system operacyjny i obcięto SVG.

Pola odpowiedzi

Pole Typ Opis
id integer Identyfikator systemu operacyjnego
name string Nazwa dystrybucji, na przykład Ubuntu lub Debian
svg_icon string Wnętrznakowanie logo SVG (nie URL)
versions array Aktywne wersje można zainstalować
versions[].uuid string Użyj jako operacjonowania_system_version_uuid podczas tworzenia serwera
versions[].name string Wersja i architektura, np. 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Nazwa i ikona systemu operacyjnego rodzicielskiego
versions[].is_active boolean Czy wersja może być użyta dla nowych serwerów

Kody statusu odpowiedzi

200 Pomyślnie odzyskana lista systemów operacyjnych
403 Brak lub nieprawidłowy token API, lub token brakuje wymaganego pozwolenia
DOSTAWAĆ /api/v1/operating-systems/{id}/

Pobierz system operacyjny

Zwraca jeden system operacyjny i jego aktywne wersje, z powyższymi polami.

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

Kody statusu odpowiedzi

200 Sukces
404 Brak systemu operacyjnego z tym identyfikatorem

Wybieranie wersji

Wyszukaj wersje nazwy podczas uruchamiania zamiast twardego kodowania uuid, więc twoja integracja nadal działa, gdy wersje są dodawane lub stanowczo. Dane logowania root są wysyłane do właściciela konta po gotowości serwera; dodaj klucz SSH podczas tworzenia serwera, który ma się zalogować z kluczem.