VPS.org API

Документація з програмного інтерфейсу REST

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

Показує список операційних систем, які ви можете встановити і їх версії. Передайте версію uid як Action_ 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 Під час створення сервера використовувати Action_ 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 Немає операційної системи з цим ідентифікатором

Як вибрати версію

Пошукати версії за назвами під час запуску замість жорсткого кодування uid, отже ваша інтеграція продовжуватиме працювати, якщо додані версії буде додано або відпущено. Подробиці реєстрації користувача root буде надіслано власнику облікового запису після того, як сервер буде готовий; додавати ключ SSH під час створення сервера, щоб увійти до системи за допомогою клавіші.