VPS.org API

Документація з програмного інтерфейсу REST

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 Так, коли знімок буде завершено
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"
POST /api/v1/servers/{uuid}/snapshot/

Створити знімок

Поставити у чергу знімок сервера, що запускається, і повернути uid нового знімка. Знімок буде показано одразу у списку зготовним встановленом у значення 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 немає дії або позначки знімка, або сервер ще не було задіяно
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 Не знайдено або він належить іншому обліковому запису

Нотатки