VPS.org API

REST API Documentation

Operativsystemer API

Liste over de operativsystemer, du kan installere, og deres versioner. Pass en versions uuid som operativ_system_version_uuid, når du opretter en server.

Endepunkter 2
Basissti /api/v1/operating-systems
FÅ /api/v1/operating-systems/

Liste over operativsystemer

Returnerer hvert operativsystem med dets aktive versioner. Listen har ingen filtre.

Krævet tilladelse: operating-systems:list

Eksempel på anmodning

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

Eksempel på svar

{
  "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: kun ét operativsystem vises og SVG markup er skåret.

Svarfelter

Felt Type Description
id integer Operativsystemidentifikator
name string Distributionsnavn, f.eks. Ubuntu eller Debian
svg_icon string Inline SVG opmærkning af logoet (ikke en URL)
versions array Aktive versioner du kan installere
versions[].uuid string Brug som operativ_system_version_uuid når du opretter en server
versions[].name string Version og arkitektur, for eksempel 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Navn og ikon på det oprindelige styresystem
versions[].is_active boolean Om versionen kan bruges til nye servere

Svarstatuskoder

200 List over operativsystemer, der er blevet hentet med succes
403 Manglende eller ugyldig API token, eller den token mangler den krævede tilladelse
FÅ /api/v1/operating-systems/{id}/

Få et operativsystem

Returnerer et operativsystem og dets aktive versioner, med felterne ovenfor.

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

Svarstatuskoder

200 Succes
404 Intet operativsystem med det id

Vælg en version

Look versioner op ved navn på runtime i stedet for hardcoding en uuid, så din integration holder arbejder, når versioner tilføjes eller pensioneret. Root login detaljer e-mailes til kontoen ejer, når serveren er klar; tilføje en SSH-tasten, når du opretter serveren til at logge ind med en nøgle i stedet.