VPS.org API

REST API-dokumentation

Operativsystem-API

Lista operativsystemen du kan installera och deras versioner. Skicka en versions uuid som opering_system_version_uuid när du skapar en server.

Slutpunkter 2
Basväg /api/v1/operating-systems
FÅ /api/v1/operating-systems/

Lista operativsystem

Returnerar varje operativsystem med dess aktiva versioner. Listan har inga filter.

Krav på tillstånd: operating-systems:list

Exempelförfrågan

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

Exempelsvar

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

Förkortat: endast ett operativsystem visas och SVG-markeringen klipps.

Svarsfält

Fält Typ Varuslag
id integer Identifiering av operativsystem
name string Distributionsnamn, till exempel Ubuntu eller Debian
svg_icon string Inline SVG- markering av logotypen (inte en URL)
versions array Aktiva versioner som du kan installera
versions[].uuid string Använd som opering_system_version_uuid när du skapar en server
versions[].name string Version och arkitektur, till exempel 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Namn och ikon för det ursprungliga operativsystemet
versions[].is_active boolean Om versionen kan användas för nya servrar

Svarsstatuskoder

200 Framgångsrikt hämtad lista över operativsystem
403 Saknas eller ogiltig API- token, eller token saknar den behörighet som krävs
FÅ /api/v1/operating-systems/{id}/

Skaffa ett operativsystem

Returnerar ett operativsystem och dess aktiva versioner, med fälten ovan.

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

Svarsstatuskoder

200 Lyckades
404 Inget operativsystem med det id-kortet

Välja en version

Titta upp versioner med namn vid körning istället för att hårdkoda en uuid, så din integration fortsätter att fungera när versioner läggs till eller pensioneras. Roten inloggningsuppgifter skickas till kontoägaren när servern är klar; lägga till en SSH-nyckel när servern skapas för att logga in med en nyckel istället.