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 Име на сървъра, от който е взета снимката, или null, ако този сървър вече не съществува
ready boolean Вярно, след като снимката приключи
deleting boolean Вярно, докато е в ход за заличаване
created_at datetime Време на създаване (ISO 8601, UTC)
size_gb number Стиснат размер в гигабайти
ПОЛУЧИ /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 липсва действие или shipe_ 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 Не е намерено или принадлежи на друга сметка

Бележки