VPS.org API

REST API Documentation

API ya Machitidwe Ogwirira Ntchito

Limbikitsani machitidwe ogwiritsira ntchito omwe mungatsekere ndi zigawo zawo. Patsani uuid ya mtundu monga operating_system_version_uuid pamene mukupanga seva.

Mapeto 2
Njira Yoyambira /api/v1/operating-systems
Pezani /api/v1/operating-systems/

Lingaliro la Operating Systems

Imaperekanso ntchito zonse za OS ndi zigawo zake zogwira ntchito. Lipotili silinathe kuchotsa.

Kufunikira kwa ufulu: operating-systems:list

Chitsanzo cha Pempho

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

Chitsanzo cha Yankho

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

Kufupikitsidwa: njira yogwiritsira ntchito imodzi yokha imawonedwa ndipo ma SVG amachepetsedwa.

Mayankho a Minda

Kuwala Mtundu Kufotokozera
id integer Chidziwitso cha dongosolo logwiritsira ntchito
name string dzina la kugawidwa, monga Ubuntu kapena Debian
svg_icon string Inline SVG kulemba kwa logo (si URL)
versions array Mapangidwe ogwira ntchito omwe mungayikitsire
versions[].uuid string Use as operating_system_version_uuid when creating a server
versions[].name string Chithunzi ndi chikhalidwe, mwachitsanzo 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string dzina ndi chithunzithunzi cha dongosolo logwiritsira ntchito loyamba
versions[].is_active boolean Ngati mtunduwu ungagwiritsidwe ntchito pa ma seva atsopano

Makhodi a Mkhalidwe Woyankha

200 Kusangalala ndi kubwezeretsa mnda wa machitidwe ogwiritsira ntchito
403 Kukayika kapena ayi API token, kapena token alibe zofunika chilolezo
Pezani /api/v1/operating-systems/{id}/

Pezani dongosolo logwiritsira ntchito

Kubwerera imodzi operating system ndi zake zogwira ntchito zigawo, ndi nyanja pamwamba.

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

Makhodi a Mkhalidwe Woyankha

200 Kupambana
404 Sitima yogwiritsira ntchito yopanda id iyi

Kusankha mtundu

Pezani zigawo ndi dzina pa runtime kuposa hardcoding uuid, kotero kuphatikizika kwanu kumagwira ntchito pamene zigawo zimawonjezedwa kapena kuchoka. Root login deta imatumizidwa ku akaunti ya woyang'anira pamene seva ikugwira ntchito; kuwonjezera SSH chingwe pamene kulenga seva kulowa ndi chingwe.