VPS.org API

Documentation de l'API REST

API des systèmes d'exploitation

Énumérez les systèmes d'exploitation que vous pouvez installer et leurs versions. Passez l'uid d'une version comme operation_system_version_uuid lorsque vous créez un serveur.

Points d'extrémité 2
Chemin de base /api/v1/operating-systems
OBTENIR /api/v1/operating-systems/

Liste des systèmes d'exploitation

Retourne chaque système d'exploitation avec ses versions actives. La liste n'a pas de filtres.

Autorisation requise: operating-systems:list

Exemple de requête

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

Exemple de réponse

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

Raccourci : un seul système d'exploitation est montré et le marquage SVG est coupé.

Champs de réponse

Champ Taper Désignation des marchandises
id integer identificateur du système d'exploitation
name string Nom de distribution, par exemple Ubuntu ou Debian
svg_icon string Marquage en ligne SVG du logo (pas une URL)
versions array Versions actives que vous pouvez installer
versions[].uuid string Utiliser comme opering_system_version_uuid lors de la création d'un serveur
versions[].name string Version et architecture, par exemple 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Nom et icône du système d'exploitation parent
versions[].is_active boolean Indique si la version peut être utilisée pour de nouveaux serveurs

Codes d'état de réponse

200 Liste des systèmes d'exploitation récupérés avec succès
403 Jeton API manquant ou invalide, ou le jeton manque la permission requise
OBTENIR /api/v1/operating-systems/{id}/

Obtenez un système d'exploitation

Retourne un système d'exploitation et ses versions actives, avec les champs ci-dessus.

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

Codes d'état de réponse

200 Succès
404 Aucun système d'exploitation avec cet id

Choisir une version

Regardez les versions par nom à l'exécution au lieu de coder un uuid, de sorte que votre intégration continue de fonctionner lorsque les versions sont ajoutées ou retirées. Les détails de connexion racine sont envoyés par courriel au propriétaire du compte une fois le serveur prêt; ajoutez une clé SSH lors de la création du serveur pour se connecter avec une clé à la place.