VPS.org API

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

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

Список операционных систем, доступных для установки, и их версий. Передайте uuid версии как 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 Использовать в качестве операционной системы_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, так что ваша интеграция продолжает работать, когда версии добавлены или отключены. Детали входа в систему направляются по электронной почте владельцу счета после того, как сервер будет готов; добавьте ключ SSH при создании сервера для регистрации с ключом.