VPS.org API

Документация REST API

API резервного копирования

Перечислите резервное копирование сервера, запустите новое резервное копирование и верните сервер с одного.

Конечные точки 4
Базовый путь /api/v1/backups
ПОЛУЧАТЬ /api/v1/backups/

Список всех резервных копий

Вернуть резервное копирование всех ваших серверов, сначала новенькое, 25 на страницу. Нет фильтра сервера: использовать сервер_призрачное имя для их группирования.

Требуемое разрешение: backups:list

Параметры запроса

Параметр Тип Необходимый Описание
page integer Нет Номер страницы, начиная с 1

Пример запроса

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

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

response = requests.get(url, headers=headers)
for backup in response.json()["results"]:
    print(backup["id"], backup["server_hostname"], backup["created_at"])
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

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

Пример ответа

{
  "count": 96,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [
    {
      "id": 5512,
      "server_hostname": "web-01",
      "name": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
      "size_gb": 3.12,
      "deletion_date": "2026-09-21T20:45:40.697512Z",
      "days_remaining": 6,
      "created_at": "2026-09-14T20:45:40.699494Z"
    }
  ]
}

Поля ответа

Полевая Тип Описание
id integer Запасной идентификатор, используемый для получения и восстановления конечных точек
server_hostname string Имя сервера, резервное копирование было взято из
name string Имя архивного файла
size_gb number Размеры в гигабайтах
deletion_date datetime Когда резервное копирование будет удалено автоматически
days_remaining integer Целые дни до исключения_дата
created_at datetime Время создания (ISO 8601, UTC)

Коды состояния ответа

200 Успешно извлечен список резервных копий
403 Недопущенный или недействительный токен API или же знак не имеет требуемого разрешения
ПОЛУЧАТЬ /api/v1/backups/{id}/

Подкрепить

Возвращает один запасной объект с полем выше.

curl -X GET "https://admin.vps.org/api/v1/backups/5512/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
ДОЛЖНОСТНЫЕ ЛИЦА /api/v1/servers/{uuid}/backup/

Создать резервную копию

Кью-экран развертываемого сервера. Тело запроса не требуется. Резервное копирование появляется в списке после его завершения, что может занять несколько минут в зависимости от использования диска.

Требуемое разрешение: servers:backup

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/backup/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

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

response = requests.post(url, headers=headers)
print(response.json())

Пример ответа

{
  "message": "Backup queued successfully"
}

Коды состояния ответа

200 Действие было определено в очереди
400 Сервер еще не запущен
402 Отсутствие метода оплаты по документам или неоплаченные счета-фактуры
404 Не найдена, или принадлежит другому счету.
ДОЛЖНОСТНЫЕ ЛИЦА /api/v1/backups/{id}/restore/

Возвращение сервера из резервного копирования

Остановить сервер, с которого было взято резервное копирование, перезаписать его диск с копией и запустить его снова. Тело запроса не требуется. Статус сервера в очереди, пока работает восстановление.

Требуемое разрешение: backups:restore

curl -X POST "https://admin.vps.org/api/v1/backups/5512/restore/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Backup restore queued. The server will be stopped, restored, and restarted.",
  "backup": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
  "job_id": "b6f1c7e2-3a4d-4f5e-8b9c-0d1e2f3a4b5c"
}
Внимание: Все, что было написано на сервере после того, как было взято резервное копирование, потеряно.

Коды состояния ответа

200 Действие было определено в очереди
400 Сервер еще не запущен
404 Не найдена, или принадлежит другому счету.

Примечания