VPS.org API

REST API -dokumentaatio

Käyttöjärjestelmien API

Luettele käyttöjärjestelmät ja niiden versiot. Syötä version uuid käyttöjärjestelmänä_system_version_uuid, kun luot palvelimen.

Päätepisteet 2
Perusreitti /api/v1/operating-systems
SAADA /api/v1/operating-systems/

Luettelo käyttöjärjestelmistä

Palauttaa jokaisen käyttöjärjestelmän aktiiviversioineen. Luettelossa ei ole suodattimia.

Vaadittu lupa: operating-systems:list

Esimerkkipyyntö

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

Esimerkkivastaus

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

Lyhennettynä: vain yksi käyttöjärjestelmä näytetään ja SVG-merkintä leikataan.

Vastauskentät

Kenttä Tyyppi Tavaran kuvaus
id integer Käyttöjärjestelmän tunniste
name string Jakelunimi, esimerkiksi Ubuntu tai Debian
svg_icon string logon Inline SVG-merkintä (ei URL)
versions array Aktiiviset versiot, jotka voit asentaa
versions[].uuid string Käytä palvelimen luomisessa käyttö_system_version_uuidina
versions[].name string Malli ja arkkitehtuuri, esimerkiksi 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Emokäyttöjärjestelmän nimi ja kuvake
versions[].is_active boolean Voidaanko versiota käyttää uusille palvelimille

Vastauksen tilakoodit

200 Onnistunut käyttöjärjestelmien lista
403 Puuttuva tai virheellinen API-tunnus tai postimerkki puuttuu vaaditusta luvasta
SAADA /api/v1/operating-systems/{id}/

Hanki käyttöjärjestelmä

Palauttaa yhden käyttöjärjestelmän ja sen aktiiviversiot yllä olevien kenttien avulla.

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

Vastauksen tilakoodit

200 Onnistuminen
404 Ei käyttöjärjestelmää, jossa on kyseinen tunniste

Version valitseminen

Etsi versiot nimi kerrallaan uuidin koodaamisen sijaan, joten integrointisi toimii, kun versiot lisätään tai poistetaan käytöstä. Juurien kirjautumistiedot lähetetään tilinomistajalle, kun palvelin on valmis; lisää SSH-avain, kun luot palvelimen, jonka avulla voit kirjautua sisään avaimella.