VPS.org API

Dokumentasi API REST

API Sistem Operasi

Menampilkan daftar sistem operasi yang dapat Anda instal beserta versinya. Kirimkan uuid dari sebuah versi sebagai operating_system_version_uuid saat Anda membuat server.

Titik akhir 2
Jalur Dasar /api/v1/operating-systems
MENDAPATKAN /api/v1/operating-systems/

Daftar Sistem Operasi

Mengembalikan setiap sistem operasi dengan versi aktifnya. Daftar tidak memiliki filter.

Perlu izin: 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 Jawaban

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

Dipersingkat: hanya satu sistem operasi yang ditampilkan dan markup SVG dipotong.

Kolom Respons

Ruas Jenis Deskripsi
id integer Identifier sistem operasi
name string Nama distribusi, misalnya Ubuntu atau Debian
svg_icon string Markup Inline SVG dari logo (bukan sebuah URL)
versions array Versi aktif yang dapat Anda pasang
versions[].uuid string Gunakan sebagai operasi_system_version_uuid ketika membuat server
versions[].name string Versi dan arsitektur, misalnya 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Nama dan ikon sistem operasi induk
versions[].is_active boolean Apakah versi dapat digunakan untuk server baru

Kode Status Respons

200 Berhasil mengambil daftar sistem operasi
403 Hilang atau token API tak valid, atau token kurang izin yang diperlukan
MENDAPATKAN /api/v1/operating-systems/{id}/

Dapatkan Sistem Operasi

Mengembalikan satu sistem operasi dan versi aktifnya, dengan bidang di atas.

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

Kode Status Respons

200 Berhasil
404 Tidak ada sistem operasi dengan id yang

Memilih Versi

Lihatlah versi atas dengan nama saat berjalan ketimbang hardcoding sebuah uuid, sehingga integrasi Anda tetap bekerja ketika versi ditambahkan atau pensiun. Rincian log masuk root diemail ke pemilik akun setelah server siap; tambahkan kunci SSH ketika membuat server untuk log masuk dengan kunci.