VPS.org API

REST API-documentatie

API voor besturingssystemen

Geef een lijst van de besturingssystemen die u kunt installeren en hun versies. Geef een versie uuid als Operation_system_version_uuid wanneer u een server aanmaakt.

Eindpunten 2
Basispad /api/v1/operating-systems
KRIJGEN /api/v1/operating-systems/

Lijst van besturingssystemen

Geeft elk besturingssysteem met zijn actieve versies terug. De lijst heeft geen filters.

Vereiste toestemming: operating-systems:list

Voorbeeldverzoek

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

Voorbeeldantwoord

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

Verkort: er wordt slechts één besturingssysteem getoond en de SVG-markering wordt geknipt.

Antwoordvelden

Veld Type Omschrijving
id integer Identificatiecode van het besturingssysteem
name string Distributienaam, bijvoorbeeld Ubuntu of Debian
svg_icon string Inline SVG-markering van het logo (geen URL)
versions array Actieve versies die u kunt installeren
versions[].uuid string Gebruik als Operation_system_version_uuid bij het aanmaken van een server
versions[].name string Versie en architectuur, bijvoorbeeld 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Naam en pictogram van het moederbesturingssysteem
versions[].is_active boolean Of de versie gebruikt kan worden voor nieuwe servers

Responsstatuscodes

200 Opgehaalde lijst met besturingssystemen succesvol
403 Ontbrekende of ongeldige API token, of het token mist de vereiste toestemming
KRIJGEN /api/v1/operating-systems/{id}/

Een besturingssysteem ophalen

Geeft één besturingssysteem en de actieve versies, met de bovenstaande velden.

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

Responsstatuscodes

200 Succes
404 Geen besturingssysteem met die id

Een versie kiezen

Kijk op naam op runtime in plaats van op een uuid, zodat uw integratie blijft werken wanneer versies worden toegevoegd of gepensioneerd. Root login details worden gemaild naar de eigenaar van het account zodra de server klaar is; voeg een SSH sleutel toe bij het aanmaken van de server om in te loggen met een sleutel.