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

短縮: 1 つのオペレーティングシステムのみを表示し、SVG マークアップを削除します。

応答フィールド

フィールド タイプ 説明
id integer オペレーティングシステム識別子
name string ディストリビューション名, 例えば Ubuntu または Debian
svg_icon string ロゴのインライン SVG マークアップ (URL ではありません)
versions array インストールできるアクティブなバージョン
versions[].uuid string サーバを作成するときに OS_Version_UID として使用
versions[].name string バージョンとアーキテクチャ、例えば 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string 親オペレーティングシステムの名前とアイコン
versions[].is_active boolean 新しいサーバでこのバージョンを使用できるかどうか

応答ステータスコード

200 検索成功したOSの一覧
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 をハードコード化する代わりに、ランタイムでバージョン名でバージョンを検索します。バージョンが追加されたり廃止されたりしたときにも、統合は動作します。サーバが準備完了したら、root ログイン情報はアカウントオーナーにメールされます。代わりに鍵でログインするには、サーバを作成するときに SSH 鍵を追加してください。