VPS.org API

Documentare API REST

API-ul sistemelor de operare

List the operating systems you can install and their versions. Pass a version's uuid as operating_system_version_uuid when you create a server.

Puncte finale 2
Calea de bază /api/v1/operating-systems
OBŢINE /api/v1/operating-systems/

Listă sisteme de operare

Returnează fiecare sistem de operare cu versiunile sale active. Lista nu are filtre.

Permisul necesar: operating-systems:list

Exemplu de solicitare

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

Exemplu de răspuns

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

Scurtat: se afișează doar un singur sistem de operare și marca SVG este tăiat.

Câmpuri de răspuns

Câmp Tip Descriere
id integer Identificator de sistem de funcționare
name string Numele distribuției, de exemplu Ubuntu sau Debian
svg_icon string Marcaj SVG inline al logo-ului (nu este un URL)
versions array Versiuni active puteți instala
versions[].uuid string Use as operating_system_version_uuid when creating a server
versions[].name string Versiune și arhitectură, de exemplu 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Numele și icoana sistemului de operare părinte
versions[].is_active boolean Dacă versiunea poate fi utilizată pentru servere noi

Coduri de stare a răspunsului

200 Lista sistemelor de operare recuperate cu succes
403 Token API lipsă sau nu este valid, sau tokenul nu este permisul necesar
OBŢINE /api/v1/operating-systems/{id}/

Obțineți un sistem de funcționare

Returnează un sistem de operare și versiunile sale active, cu câmpurile de mai sus.

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

Coduri de stare a răspunsului

200 Succes
404 Niciun sistem de operare cu id

Alegerea unei versiuni

Caută versiuni după nume la runtime în loc de a hardcoding un uuid, astfel încât integrarea dumneavoastră continuă să funcționeze atunci când versiunile sunt adăugate sau retrase. Detaliile loginului de root sunt trimise în email proprietarului contului odată ce serverul este gata; adaugă o cheie SSH atunci când creează serverul pentru a se conecta cu o cheie în schimb.