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 Правда, когда снимок будет готов
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/

Создать снимок

Вычисляет снимок развернутого сервера и возвращает новый снимок uuid. Снимок указан прямо сейчас с готовым к фальшивке.

Требуемое разрешение: 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 Не найдена, или принадлежит другому счету.

Примечания