VPS.org API

REST API dokumentacija

Operacinių sistemų API

Išvardinkite operacines sistemas, kurias galite įdiegti, ir jų versijas. Sukūrę serverį, perduodate versijos uuid kaip operacinę_system_version_uid.

Galutiniai taškai 2
Bazinis kelias /api/v1/operating-systems
GAUTI /api/v1/operating-systems/

Įrašyti operacines sistemas

Atkuria kiekvieną operacinę sistemą su jos aktyviomis versijomis. Sąraše nėra filtrų.

Reikalingas leidimas: operating-systems:list

Prašymo pavyzdys

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

Atsakymo pavyzdys

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

Sutrumpintas: rodoma tik viena operacinė sistema ir atkirstas SVG ženklas.

Atsakymo laukai

Laukas Tipas Aprašymas
id integer Operacinės sistemos identifikatorius
name string Platinimo pavadinimas, pvz., Ubuntu arba Debian
svg_icon string Įtrauktas logotipo SVG žymėjimas (ne URL)
versions array Aktyvias versijas galite įdiegti
versions[].uuid string Kuriant serverį naudoti kaip operacinį_system_version_uuid
versions[].name string Versija ir architektūra, pvz., 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Pagrindinės operacinės sistemos pavadinimas ir piktograma
versions[].is_active boolean Ar versija gali būti naudojama naujiems serveriams

Atsakymo būsenos kodai

200 Sėkmingai atgautas operacinių sistemų sąrašas
403 Trūksta arba netinkamas API žetonas, arba žetonas neturi reikiamo leidimo
GAUTI /api/v1/operating-systems/{id}/

Gauti operacinę sistemą

Sugrąžina vieną operacinę sistemą ir jos aktyviąsias versijas su pirmiau nurodytais laukeliais.

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

Atsakymo būsenos kodai

200 Sėkmė
404 Nėra operacinės sistemos su tokiu ID

Pasirinkti versiją

Paieškokite versijų pagal pavadinimą paleidimo metu, o ne užkietėjusiu uuid, todėl jūsų integracija veikia, kai versijos yra pridedamos arba ištrintos. Rot login duomenys el. paštu siunčiami sąskaitos savininkui, kai serveris yra pasiruošęs; įdėkite SSH raktą, kai bus sukurtas serveris prisijungti su raktu.