VPS.org API

REST API dokumentacija

API operacijskih sistemov

Naštejte operativne sisteme, ki jih lahko namestite, in njihove različice. Podajte različico uuid kot operating_system_version_ uuid, ko ustvarite strežnik.

Končne točke 2
Osnovna pot /api/v1/operating-systems
PRIDOBITE /api/v1/operating-systems/

Seznam operacijskih sistemov

Vrne vsak operacijski sistem z aktivnimi različicami. Seznam nima filtrov.

Zahtevano dovoljenje: operating-systems:list

Primer zahteve

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

Primer odgovora

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

Skrajšanje: prikazan je samo en operacijski sistem in SVG označevanje rezanje.

Polja za odgovor

Polje Vrsta Opis
id integer Identifikator operativnega sistema
name string Ime za razširjanje, na primer Ubuntu ali Debian
svg_icon string Vnos SVG označevanja logotipa (ni URL)
versions array Aktivne različice, ki jih lahko namestite
versions[].uuid string Uporabi kot operating_system_version_uuid pri ustvarjanju strežnika
versions[].name string Različica in arhitektura, na primer 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Ime in ikona starševskega operativnega sistema
versions[].is_active boolean Ali se različica lahko uporablja za nove strežnike

Kode stanja odgovora

200 Seznam operacijskih sistemov, ki je bil uspešno pridobljen
403 Manjkajoči ali neveljavni API žeton, ali token manjka zahtevano dovoljenje
PRIDOBITE /api/v1/operating-systems/{id}/

Poišči operativni sistem

Vrne en operacijski sistem in njegove aktivne različice, z zgornjimi polji.

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

Kode stanja odgovora

200 Uspeh
404 Ni operativnega sistema s tem id.

Izbira različice

Iščite različice po imenu ob runtime namesto trdega kodiranja uuid, tako da vaše vključevanje nadaljuje delo, ko se različice dodajo ali upokojijo. Root login podrobnosti so poslani e-poštnim naslovom lastniku računa, ko je strežnik pripravljen; dodajte SSH ključ pri ustvarjanju strežnika za prijavo z ključem.