VPS.org API

Dokumintaasje

Bestjoeringssystemen API

List de bestjoeringssystemen dy jo ynstallearje kinne en har ferzjes. Jou de uuid fan in ferzje troch as operating_system_version_uuid as jo in tsjinner oanmeitsje.

Einpunten 2
Basispaad /api/v1/operating-systems
KRIJE /api/v1/operating-systems/

List fan bestjoeringssystemen

Jout elk bestjoeringssysteem werom mei de aktive ferzjes. De list hat gjin filters.

Tagongsrjochten fereaske: operating-systems:list

Foarbyldfersyk

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

Foarbyldantwurd

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

Ynkoarte: allinne ien bestjoeringssysteem wurdt werjûn en de SVG- markearring is ôfkoart.

Antwurdfjilden

Fjild Type Beskriuwing
id integer Bestimmingssysteem- identifikaasje
name string Distribúsje namme, bygelyks Ubuntu of Debian
svg_icon string Ynline SVG- opmaak fan it logo (net in URL- adres)
versions array Aktyf ferzjes dy jo ynstallearje kinne
versions[].uuid string Brûk as operating_system_version_uuid by it oanmeitsjen fan in tsjinner
versions[].name string Version and architecture, for example 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Namme en byldkaike fan it boppelizzende bestjoeringssysteem
versions[].is_active boolean Of de ferzje brûkt wurde kin foar nije tsjinners

Antwurdstatuskoades

200 List mei sukses ophelle bestjoeringssystemen
403 Untbrekkend of ûnjildich API-token, of it token hat net de fereaske tagongsrjochten
KRIJE /api/v1/operating-systems/{id}/

In bestjoeringssysteem ophelje

Jout ien bestjoeringssysteem en syn aktive ferzjes werom, mei de fjilden hjirboppe.

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

Antwurdstatuskoades

200 Suksesfol
404 Gjin bestjoeringssysteem mei dat id

In ferzje kieze

Sykje ferzjes op nei namme by runtime ynstee fan in hardcoding uuid, sadat jo yntegraasje hâldt wurkjen as ferzjes wurde tafoege of fuortsmiten. Root oanmeld details wurde e- mailt nei de akkount eigener as de tsjinner klear is; foegje in SSH kaai ta as jo de tsjinner oanmeitsje om yn te loggen mei in kaai ynstee.