VPS.org API

Ҳуҷҷатгузории REST API

API-и системаҳои амалиётӣ

Рӯйхати системаҳои оператсионии шумо ва версияҳои онҳо. Дар вақти эҷоди сервер uuid-и версияро ҳамчун operating_system_version_uuid гузаронед.

Нуқтаҳои ниҳоӣ 2
Роҳи асосӣ /api/v1/operating-systems
ГИРЕД /api/v1/operating-systems/

Рӯйхати системаҳои оператсионӣ

Ҳар як системаи оператсионӣ бо версияҳои фаъолро бар мегардонад. Рӯйхат филтрҳо надорад.

Иҷозат лозим аст: operating-systems:list

Намунаи дархост

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

Намунаи посух

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

Хурд карда шуд: танҳо як системаи оператсионӣ нишон дода мешавад ва SVG маркировка бурида мешавад.

Майдонҳои посух

& Файл Навъ & Тасвирот
id integer Идентификатори системаи оператсионӣ
name string Номи тақсимот, масалан Ubuntu ё Debian
svg_icon string SVG- и дарунсохт барои нишони (на URL)
versions array Версияҳои фаъол, ки шумо метавонед насб кунед
versions[].uuid string Истифодаи ҳамчун operating_system_version_uuid ҳангоми эҷоди сервер
versions[].name string Версия ва архитектура, масалан 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Номи системаи оператсионии падар ва нишонаи он
versions[].is_active boolean Оё барои серверҳои нав версия истифода бурда мешавад

Рамзҳои ҳолати посух

200 Рӯйхати системаҳои оператсионии бомуваффақият гирифташуда
403 API-и нодуруст ё гумшуда ё иҷозатномаи лозимӣ барои token нест
ГИРЕД /api/v1/operating-systems/{id}/

Системаи оператсионӣ

Як системаи оператсионӣ ва версияи фаъолро бо заминаҳои болоӣ бар мегардонад.

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

Рамзҳои ҳолати посух

200 Муваффақият
404 Ягон системаи оператсионӣ бо ин ID нест

Интихоби версия

Дар вақти иҷроиш ба ҷои кодгузории uuid-и сахт версияҳоро бо номи худ ҷустуҷӯ кунед, то ин ки ҳамгироӣ ҳангоми илова ё барҳам додани версияҳо кор кунад. Маълумоти воридшавии root ба соҳибони ҳисобҳо бо почтаи электронӣ фиристода мешавад, вақте ки сервер омода аст; калиди SSH-ро ҳангоми эҷоди сервер барои воридшавӣ бо калид илова кунед.