VPS.org API

Dokumentace REST API

API operačních systémů

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.

Koncové body 2
Základní cesta /api/v1/operating-systems
ZÍSKAT /api/v1/operating-systems/

Seznam operačních systémů

Vrací každý operační systém s jeho aktivní verzí. Seznam nemá žádné filtry.

Požadované povolení: operating-systems:list

Příklad žádosti

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

Příklad odpovědi

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

Zkráceno: zobrazí se pouze jeden operační systém a markup SVG je přerušen.

Pole odpovědí

Pole Typ Popis zboží
id integer Identifikátor operačního systému
name string Název distribuce, například Ubuntu nebo Debian
svg_icon string Inline SVG markup loga (ne URL)
versions array Aktivní verze, které můžete nainstalovat
versions[].uuid string Použít jako operační_system_version_uuid při vytváření serveru
versions[].name string Verze a architektura, například 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Název a ikona základního operačního systému
versions[].is_active boolean Zda lze verzi použít pro nové servery

Kódy stavu odpovědi

200 Úspěšně získaný seznam operačních systémů
403 Chybí nebo neplatná API žeton, nebo žeton postrádá požadované povolení
ZÍSKAT /api/v1/operating-systems/{id}/

Získat operační systém

Vrací jeden operační systém a jeho aktivní verze, s výše uvedenými poli.

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

Kódy stavu odpovědi

200 Úspěch
404 Žádný operační systém s touto id

Vybírání verze

Podívejte se na verze podle jména v runtime místo hardkódování uuid, takže vaše integrace pracuje, když se přidají nebo odejdou. Root login podrobnosti jsou e-mailem pro majitele účtu, jakmile je server připraven; přidat SSH klíč při vytváření serveru pro přihlášení s klíčem místo.