VPS.org API

API- документација

API за слики

Земете ги ознакените снимки на серверот, набројте гизбришете ги оние што повеќе не ви требаат.

Крајни точки 4
Основна патека /api/v1/snapshots
ДОБИЈ /api/v1/snapshots/

Листај ги сите снимки

Ги враќа снимките од вашата сметка, најновите први, 25 на страница.

Неопходна дозвола: snapshots:list

Пример за барање

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/snapshots/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/snapshots/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for snapshot in response.json()["results"]:
    print(snapshot["uuid"], snapshot["label"], snapshot["ready"])
const response = await fetch('https://admin.vps.org/api/v1/snapshots/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

Пример за одговор

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b",
      "label": "before-upgrade",
      "server_hostname": "web-01",
      "ready": true,
      "deleting": false,
      "created_at": "2026-09-14T18:30:00.000000Z",
      "size_gb": 3.4
    }
  ]
}

Полиња за одговор

Поле Тип Опис
uuid string Идентификатор на снимање (32 хексадецимални знаци, без цртачи)
label string Ознаката е дадена кога е создадена снимката
server_hostname string Името на серверот од кој беше направена снимката, или null ако серверот повеќе не постои
ready boolean Вистина кога снимката ќе заврши
deleting boolean Вистина додека се извршува бришењето
created_at datetime Време на создавање (ISO 8601, UTC)
size_gb number Компресирана големина во gigabytes
ДОБИЈ /api/v1/snapshots/{uuid}/

Снимај снимка

Враќа еден објект со полињата горе. Користете го за да ги анкетирате подготвените по создавањето на снимката.

curl -X GET "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
ПОСТ /api/v1/servers/{uuid}/snapshot/

Креирај снимање

Го враќа ууидот на новата снимка. Снимката е наведена веднаш со подготвена поставена на лажна.

Неопходна дозвола: servers:snapshot

Параметри на телото на барањето

Параметр Тип Задолжително Опис
action string Да Сигурно е снимка
snapshot_label string Да Натпис за препознавање на снимката од
cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/snapshot/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action": "snapshot", "snapshot_label": "before-upgrade"}'
import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/snapshot/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
data = {"action": "snapshot", "snapshot_label": "before-upgrade"}

response = requests.post(url, headers=headers, json=data)
print(response.json()["snapshot_uuid"])

Пример за одговор

{
  "message": "Snapshot queued successfully",
  "snapshot_uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b"
}

Кодови за статус на одговор

200 Дејството беше во редица
400 акција или снимка_ ознака недостасува, или серверот не е активиран
402 Нема метод на плаќање на датотеката, ниту неплатени фактури
404 Не е пронајдено или припаѓа на друга сметка
ИЗБРИШИ /api/v1/snapshots/{uuid}/

Избриши снимање

Ја реди снимката за трајно бришење. Бришењето е вистинито додека не ја нема.

Неопходна дозвола: snapshots:delete

curl -X DELETE "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Snapshot deletion queued"
}

Кодови за статус на одговор

202 Прифатено: барањето беше во редица
404 Не е пронајдено или припаѓа на друга сметка

Забелешки