VPS.org API

REST API- dokumentasjon

Operativsystemer API

List operativsystemene du kan installere og deres versjoner. Passer en versjons uuid som operativsystem_ system_ version_ uuid når du oppretter en tjener.

Endepunkter 2
Basissti /api/v1/operating-systems
BLI /api/v1/operating-systems/

Liste over operativsystemer

Returnerer hvert operativsystem med aktive versjoner. Lista har ingen filtre.

Påkrevd tillatelse: operating-systems:list

Eksempelforespørsel

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

Eksempelsvar

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

Forkortet: Bare ett operativsystem vises og SVG-merking klippes.

Svarfelt

Felt Type Beskrivelse
id integer Identifikator for operativsystem
name string Distribusjonsnavn, for eksempel Ubuntu eller Debian
svg_icon string SVG- tekstmerking i logoen (ikke en URL)
versions array Aktive versjoner du kan installere
versions[].uuid string Bruk som operativsystem_ system_version_uuid når en tjener opprettes
versions[].name string Versjon og arkitektur, f.eks. 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Navn og ikon for det overliggende operativsystemet
versions[].is_active boolean Om versjonen kan brukes på nye tjenere

Svarstatuskoder

200 Liste over operativsystemer som er ferdig hentet
403 Mangler eller er ugyldig API- symbol, eller symbolet mangler tillatelse
BLI /api/v1/operating-systems/{id}/

Få et operativsystem

Returnerer ett operativsystem og dets aktive versjoner, med feltene over.

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

Svarstatuskoder

200 Vellykket
404 Intet operativsystem med den ID- en

Velge en versjon

Slå opp versjoner etter navn ved kjøring i stedet for hardcoding av en uuid, så integreringen fortsetter å virke når versjoner legges til eller trekkes tilbake. Login- detaljer fra root sendes til kontoeieren når tjeneren er klar. Legg til en SSH- nøkkel når tjeneren skal logges inn med en nøkkel i stedet.