VPS.org API

REST API документация

API на операционните системи

Изброете оперативните системи, които можете да инсталирате и техните версии. Предайте ууид на версията като operating_system_version_uuid, когато създавате сървър.

Крайни точки 2
Базов път /api/v1/operating-systems
ПОЛУЧИ /api/v1/operating-systems/

Списък на оперативните системи

Връща всяка оперативна система с активните си версии. Списъкът няма филтри.

Изискан разрешение: operating-systems:list

Примерна заявка

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

Примерен отговор

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

Скъсано: показва се само една оперативна система и SVG маркировката се отрязва.

Полета за отговор

Поле Тип Описание
id integer Идентификатор на оперативната система
name string Име на разпределение, например Ubuntu или Debian
svg_icon string Вътрешна SVG маркировка на логото (не е URL)
versions array Активни версии, които можете да инсталирате
versions[].uuid string Използване като operating_system_ version_uuid при създаване на сървър
versions[].name string Версия и архитектура, например 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Име и икона на родителската оперативна система
versions[].is_active boolean Дали версията може да се използва за нови сървъри

Кодове за състояние на отговора

200 Успешно изтеглен списък на оперативните системи
403 Липсва или невалиден API жетон, или на жетонът липсва изискваното разрешение
ПОЛУЧИ /api/v1/operating-systems/{id}/

Намерете оперативна система

Връща една оперативна система и активните ѝ версии с полетата по-горе.

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

Кодове за състояние на отговора

200 Успех
404 Няма оперативна система с тази идентификаторна карта

Избиране на версия

Виж версии по име на старттайм вместо твърдо кодиране на uuid, така че вашата интеграция продължава да работи, когато версиите се добавят или пенсионират. Root данни за входа се изпращат на собственика на сметката, след като сървърът е готов; добавете SSH ключ при създаването на сървъра, за да се впишете с ключ вместо това.