VPS.org API

REST API dokumentācija

Operētājsistēmu API

Parādiet operētājsistēmas, kuras varat instalēt, un to versijas. Izdot versijas uuid kā operētājsistēma_ version_ uuid, kad izveidosiet serveri.

Galapunkti 2
Bāzes ceļš /api/v1/operating-systems
IEGŪT /api/v1/operating-systems/

Sarakstēt operētājsistēmas

Atgriež katru operētājsistēmu ar tās aktīvajām versijām. Sarakstam nav filtru.

Nepieciešamā atļauja: operating-systems:list

Pieprasījuma piemērs

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

Atbildes piemērs

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

Saīsināts: tiek parādīta tikai viena operētājsistēma un tiek iegriezta SVG zīme.

Atbildes lauki

Lauks Tips Apraksts
id integer Ekspluatācijas sistēmas identifikators
name string Izplatīšanās nosaukums, piemēram, Ubuntu vai Debian
svg_icon string Iekļauta logo SVG marka (nav URL)
versions array Aktīvās versijas, kuras varat instalēt
versions[].uuid string Izmantot kā operētājsistēmu_version_uid, veidojot serveri
versions[].name string Versija un arhitektūra, piemēram, 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Vecākās operētājsistēmas nosaukums un ikona
versions[].is_active boolean Vai versiju var izmantot jauniem serveriem

Atbildes statusa kodi

200 Veiksmīgi iegūts operētājsistēmu saraksts
403 Trūkst vai nav spēkā API žetons, vai žetonam trūkst nepieciešamās atļaujas
IEGŪT /api/v1/operating-systems/{id}/

Iegūst operētājsistēmu

Atgriež vienu operētājsistēmu un tās aktīvās versijas, ar iepriekš minētajiem laukiem.

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

Atbildes statusa kodi

200 Panākumi
404 Nav operētājsistēmas ar šādu id

Izvēlies versiju

Izskatās versijas pēc nosaukuma palaist laiku, nevis hardcoding a uuid, tāpēc jūsu integrācija turpina darboties, kad versijas tiek pievienotas vai pensionētas. Root login informācija tiek nosūtīta uz konta īpašnieku, kad serveris ir gatavs; pievienojot SSH taustiņu, izveidojot serveri, lai pieteiktos ar atslēgu.