VPS.org API

REST API skjölun

Stýrikerfis-API

Listi yfir stýrikerfi sem hægt er að setja upp og útgáfur þeirra. Senda uuid útgáfu sem operating_system_version_uuid þegar búið er til þjón.

Endapunktar 2
Grunnslóð /api/v1/operating-systems
FÁ /api/v1/operating-systems/

Listi yfir stýrikerfi

Sýnir hvert stýrikerfi með virkum útgáfum þess. Listinn hefur engar síur.

Nauðsynlegt leyfi: operating-systems:list

Dæmi um beiðni

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

Dæmi um svar

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

Stutt: aðeins eitt stýrikerfi er sýnt og SVG merkingin er skert.

Svarsvið

Field Tegund Lýsing
id integer Auðkenni stýrikerfis
name string Heiti dreifingar, t.d. Ubuntu eða Debian
svg_icon string Inline SVG merkingar merkisins (ekki vefslóð)
versions array Virkar útgáfur sem þú getur sett upp
versions[].uuid string Nota sem operating_ system_ version_ uuid þegar búið er til þjón
versions[].name string Útgáfa og arkitektúr, til dæmis 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Heiti og táknmynd yfirstjórnkerfisins
versions[].is_active boolean Hvort hægt sé að nota útgáfuna fyrir nýja þjóna

Kóðar fyrir svörunarstöðu

200 Listi yfir stýrikerfi sem náðust
403 Vantar eða ógilt API tákn, eða táknið hefur ekki nauðsynleg leyfi
FÁ /api/v1/operating-systems/{id}/

Fáðu stýrikerfi

Sýnir eitt stýrikerfi og virkar útgáfur þess, með reitunum fyrir ofan.

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

Kóðar fyrir svörunarstöðu

200 Velgengni
404 Ekkert stýrikerfi með þetta auðkenni

Velja útgáfu

Leitaðu að útgáfum með nafni í gangtíma í stað þess að harðkóða uuid, þannig að samþættingin þín heldur áfram að vinna þegar útgáfum er bætt við eða hætt. Innskráningarupplýsingar rótar eru sendar með tölvupósti til eiganda reikningsins þegar miðlarinn er tilbúinn; bættu við SSH lykli þegar miðlarinn er búinn til til að skrá þig inn með lykli í staðinn.