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 Не е намерено или принадлежи на друга сметка

Бележки