VPS.org API

REST API 文件

操作系统 API

列出您可以安装的操作系统及其版本。 当您创建服务器时, 传递一个版本的 unued, 即操作 _ 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 标识( 不是 URL) 的 SVG 内嵌标记( 不是一个 URL)
versions array 您可以安装活动版本
versions[].uuid string 创建服务器时用作操作_ system_version_uuud
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 没有带有该ID 操作系统的操作系统

选择版本

运行时查找以名称命名的版本, 而不是硬编码 uuid, 所以当版本添加或退出时您的整合会继续运行。 服务器一旦准备好, 根登录细节就会电子邮件给账户所有者; 创建服务器时添加 SSH 密钥, 以以使用密钥登录 。