VPS.org API

REST 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 Снайперлік сурет алынған сервердің хост атауы, егер ол сервер жоқ болса, онда бұл нөл
ready boolean Снайпердің әрекеті аяқталғанда True
deleting boolean Өшіру жүріп жатқанда true
created_at datetime Құру уақыты (ISO 8601, UTC)
size_gb number Сығу өлшемі (гигабайт)
АЛУ /api/v1/snapshots/{uuid}/

Түсініктеме

Returns one snapshot object with the fields above. Use it to poll ready after creating a snapshot.

curl -X GET "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
ХАБАРЛАМА /api/v1/servers/{uuid}/snapshot/

Түсініктемесін жасау

Орнатылған сервердің скриншотын кезекке қою және жаңа скриншоттың uuid- і қайтарылады. Скрипт дереу тізімге қосылады, ready деген false деп қойылады.

Рұқсат керек: 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 action не snapshot_ label жоқ, немесе сервер әлі орналастырылмаған
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 Табылмады, немесе басқа тіркелгіге тиесілі

Жазбалар