VPS.org API

Constellation name (optional)

Bedryfstelsels API

Lys die bedryfstelsels wat jy kan installeer en hulle weergawes. Gee 'n weergawe se uUID as operating_system_version_uuid wanneer jy' n bediener skep.

Eindpunte 2
Basispad /api/v1/operating-systems
KRY /api/v1/operating-systems/

Lys Operating Stelsels

Gee terug elke bedryfstelsel met sy aktiewe weergawes. Die lys het geen filters nie.

Benodigde toestemming: operating-systems:list

Voorbeeldversoek

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

Kortweg: net een bedryfstelsel word vertoon en die SVG-merk is gesny.

Antwoordvelde

Veld Tipe Beskrywing
id integer Operating stelsel identifiseerder
name string Verspreiding naam, byvoorbeeld Ubuntu of Debian
svg_icon string Inlyn SVG-opmerking van die embleem (nie 'n URL nie)
versions array Aktiewe weergawes wat jy kan installeer
versions[].uuid string Gebruik as opera_system_version_uuid wanneer skep 'n bediener
versions[].name string Weergawe en argitektuur byvoorbeeld 24,04 LTS x64
versions[].os_name, versions[].os_svg_icon string Naam en ikoon van die ouer wat op die bedryfstelsel werk
versions[].is_active boolean Of die weergawe vir nuwe bedieners gebruik kan word

Reaksiestatuskodes

200 Suksesvol verkrying van bedryfstelselslys
403 Ontbrekende of ongeldige API-bewys, of die teken het nie die nodige toestemming nie
KRY /api/v1/operating-systems/{id}/

Kry 'n Operatingstelsel

Gee een bedryfstelsel en sy aktiewe weergawes terug, met die velde daar bo.

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

Reaksiestatuskodes

200 Sukses
404 Geen bedryfstelsel met daardie ID nie

Kies 'n weergawe

Kyk weergawes van naam na hardlooptyd in plaas van hardcoding 'n uuid, sodat jou integrasie bly werk wanneer weergawes bygevoeg of getree word. Root aanteken detail word ge-pos aan die rekening eienaar wanneer die bediener is gereed; voeg 'n SSH-sleutel by wanneer skep die bediener na log in plaas van 'n sleutel.