VPS.org API

Faʻamatalaga o le REST API

API o Faiga Fa'agaoioia

Faʻavasegaina o faiga fa'agaioiga e mafai ona e fa'apipi'i ma a latou lomiga. Tu'u le uuid o se lomiga e pei o le operating_system_version_uuid pe a e fausia se 'au'aunaga.

Fa'ai'uga 2
Ala Autu /api/v1/operating-systems
MAUA /api/v1/operating-systems/

Faʻavasegaina o faiga faʻagaioiga

Toe maua e ia faiga fa' aoga ona o ona lomiga sa' i. E leai se siaki i le lisi.

Manaomia le aia tatau: operating-systems:list

Talosaga Fa'ata'ita'i

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

Tali Fa'ata'ita'i

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

Faatosina: o se faiga fa'agaioiga e tasi lava e fa'aalia ma e ta'iala le SVG markup.

Fanua Tali

Aoga Ituaiga Faʻamatalaga
id integer Faʻailoga o le faiga faʻagaioiga
name string Le igoa o le tufatufaina, mo se faataitaiga Ubuntu po o Debian
svg_icon string Faailoga SVG i totonu o le logo (e le o se URL)
versions array Faʻavasegaina o lomiga e mafai ona faʻapipiʻi
versions[].uuid string Faʻaaoga o le operating_system_version_uuid pe a fausia se 'au'aunaga
versions[].name string Version ma architecture, mo se faataitaiga 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Le igoa ma le ata o le faiga fa'agaioiga matua
versions[].is_active boolean Pe e mafai ona faʻaaogaina le lomiga mo 'au'aunaga fou

Fa'ailoga o Tulaga o Tali

200 Faʻatonu le lisi o faiga fa'agaioiga
403 Lelei pe lē talafeagai le tokeni API, po o le tokeni e leai se aia tatau e manaʻomia
MAUA /api/v1/operating-systems/{id}/

Faʻataga se faiga faʻagaioiga

Toe foʻi i se faiga faʻagaioiga ma ona lomiga saʻo, ma le itu i luga.

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

Fa'ailoga o Tulaga o Tali

200 Fa'ataunuuina
404 E leai se faiga fa'agaioiga ma lea id

Faʻatonu se lomiga

Vaai i lomiga e tusa ai ma le igoa i le taimi o le ta'aloga e ui i le hardcoding o se uuid, ina ia tumau ai lau integration e galue pe a fa'aopopo pe fa'atapula'aina lomiga. O fa'amatalaga o le root login e fa'ameli atu i le tagata e pulea le teugatupe pe a mae'a le 'au'aunaga; fa'aopopo se SSH key pe a faia le 'au'aunaga e fa'aoga ai se key.