VPS.org API

Dokumentasi API REST

API Sistem Pengendalian

Senarai sistem operasi yang boleh dipasang dan versinya. Serahkan uuid versi sebagai operating_system_version_uuid bila anda cipta pelayan.

Titik akhir 2
Laluan Asas /api/v1/operating-systems
DAPATKAN /api/v1/operating-systems/

Senarai Sistem Operasi

Kembalikan setiap sistem operasi dengan versi aktifnya. Senarai tidak mempunyai penapis.

Keizinan diperlukan: operating-systems:list

Contoh Permintaan

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

Contoh Respons

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

Dipendek: hanya satu sistem operasi dipaparkan dan penanda SVG dipotong.

Medan Respons

Medan Jenis Huraian
id integer Pengecam sistem operasi
name string Nama Distribusi, contohnya Ubuntu atau Debian
svg_icon string Markup SVG dalam baris bagi logo (bukan URL)
versions array Versi aktif yang boleh dipasang
versions[].uuid string Guna sebagai operating_system_version_uuid bila mencipta pelayan
versions[].name string Versi dan arsitektur, contohnya 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Nama dan ikon sistem operasi ibu bapa
versions[].is_active boolean Samada versi boleh digunakan untuk pelayan baru

Kod Status Respons

200 Senarai sistem operasi berjaya diperoleh
403 Token API hilang atau tidak sah, atau token tidak mempunyai keizinan yang diperlukan
DAPATKAN /api/v1/operating-systems/{id}/

Dapatkan Sistem Operasi

Kembalikan satu sistem operasi dan versi aktifnya, dengan medan di atas.

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

Kod Status Respons

200 Kejayaan
404 Tiada sistem operasi dengan id itu

Memilih Versi

Lihat versi mengikut nama pada masa jalankan bukannya kod keras uuid, jadi integrasi anda tetap berfungsi bila versi ditambah atau ditarik balik. Perincian log masuk root diemailkan kepada pemilik akaun bila pelayan sedia; tambah kekunci SSH bila mencipta pelayan untuk log masuk dengan kekunci sebaliknya.