VPS.org API

Documentazione delle API REST

API dei sistemi operativi

Elenca i sistemi operativi che puoi installare e le loro versioni. Passa l'uuid di una versione come opering_system_version_uuid quando crei un server.

Punti finali 2
Percorso di base /api/v1/operating-systems
OTTENERE /api/v1/operating-systems/

Elenco sistemi operativi

Restituisce ogni sistema operativo con le sue versioni attive. L'elenco non ha filtri.

Autorizzazione richiesta: operating-systems:list

Richiesta di esempio

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

Esempio di risposta

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

Annesso: viene mostrato un solo sistema operativo e viene tagliato il markup SVG.

Campi di risposta

Campo Tipo Designazione delle merci
id integer ENTITÀ DI INFORMAZIONE
name string Nome distribuzione, per esempio Ubuntu o Debian
svg_icon string Marcatura SVG in linea del logo (non un URL)
versions array Versioni attive che puoi installare
versions[].uuid string Usa come opering_system_version_uuid quando si crea un server
versions[].name string Versione e architettura, per esempio 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Nome e icona del sistema operativo genitore
versions[].is_active boolean Indica se la versione può essere usata per i nuovi server

Codici di stato della risposta

200 Elenco dei sistemi operativi recuperati con successo
403 Token API mancante o non valido, o il token non ha il permesso richiesto
OTTENERE /api/v1/operating-systems/{id}/

Ottenere un sistema operativo

Restituisce un sistema operativo e le sue versioni attive, con i campi sopra riportati.

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

Codici di stato della risposta

200 Successo
404 Nessun sistema operativo con quell'id

Scelta di una versione

Cerca le versioni per nome al runtime invece di codificare un uuid, quindi la tua integrazione continua a funzionare quando le versioni vengono aggiunte o ritirate. I dettagli di accesso al root vengono inviati al proprietario dell'account una volta che il server è pronto; aggiungi una chiave SSH quando si crea il server per accedere con una chiave.