VPS.org API

REST API Documentation

Betriebssystem-API

Liste die Betriebssysteme, die du installieren kannst, und deren Versionen. Übergib die Version als operating_system_version_uuid, wenn du einen Server erstellst.

Endpunkte 2
Basispfad /api/v1/operating-systems
ERHALTEN /api/v1/operating-systems/

Liste Betriebssysteme

Gibt jedes Betriebssystem mit seinen aktiven Versionen zurück. Die Liste hat keine Filter.

Erforderliche Genehmigung: operating-systems:list

Beispielanfrage

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

Beispielantwort

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

Verkürzt: Es wird nur ein Betriebssystem angezeigt und der SVG-Markup geschnitten.

Antwortfelder

Feld Typ Description
id integer Kennung des Betriebssystems
name string Distributionsname, zum Beispiel Ubuntu oder Debian
svg_icon string Inline SVG Markup des Logos (keine URL)
versions array Aktive Versionen, die Sie installieren können
versions[].uuid string Als operting_system_version_uuid beim Erstellen eines Servers verwenden
versions[].name string Version und Architektur, z.B. 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Name und Symbol des übergeordneten Betriebssystems
versions[].is_active boolean Ob die Version für neue Server verwendet werden kann

Antwortstatuscodes

200 Liste der erfolgreich abgerufenen Betriebssysteme
403 Fehlendes oder ungültiges API-Token oder dem Token fehlt die erforderliche Berechtigung
ERHALTEN /api/v1/operating-systems/{id}/

Ein Betriebssystem anfordern

Gibt ein Betriebssystem und seine aktiven Versionen zurück, wobei die Felder oben stehen.

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

Antwortstatuscodes

200 Erfolg
404 Kein Betriebssystem mit dieser ID

Eine Version auswählen

Suchen Sie Versionen nach Namen bei der Laufzeit statt der Hardcodierung einer Uuid, so dass Ihre Integration funktioniert, wenn Versionen hinzugefügt oder zurückgezogen werden. Root-Login-Details werden an den Kontoinhaber gesendet, sobald der Server bereit ist; fügen Sie eine SSH-Taste beim Erstellen des Servers, um sich mit einem Schlüssel zu melden statt.