VPS.org API

REST API Documentation

Varunduste API

Loetle oma serveri varukoopiad, käivita uus varukoopia ja taasta server ühest.

Lõpp-punktid 4
Baasrada /api/v1/backups
SAA /api/v1/backups/

Loetle kõik varukoopiad

Tagastab kõigi serverite varukoopiad, mis on kõige uuemad, 25 lehekülje kohta. Serveri filtrit pole: nende rühmitamiseks kasutatakse serveri_ masina nime.

Nõutav luba: backups:list

Päringuparameetrid

Parameter Tüüp Nõutav Description
page integer No Lehekülje number, alates 1

Näidistaotlus

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);

Näidisvastus

{
  "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"
    }
  ]
}

Vastuseväljad

Väli Tüüp Description
id integer Varukoopia identifikaator, mida kasutatakse tulemuste saamiseks ja taastamiseks
server_hostname string Serveri masinanimi, kust varukoopia võeti
name string Arhiivi nime varundamine
size_gb number Tihendatud suurus gigabaitides
deletion_date datetime Kui varukoopia eemaldatakse automaatselt
days_remaining integer Terved päevad on jäänud kuni kustutamise_kuupäevani
created_at datetime Loomisaeg (ISO 8601, UTC)

Vastuse olekukoodid

200 Varukoopiate nimekiri edukalt kätte saadud
403 Puuduv või vigane API märgis või märgil puudub nõutav luba
SAA /api/v1/backups/{id}/

Otsi varukoopia

Tagastab ühe varuobjekti ülalolevate väljadega.

curl -X GET "https://admin.vps.org/api/v1/backups/5512/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
POST /api/v1/servers/{uuid}/backup/

Loo varukoopia

Seab paika varukoopia kasutusel olevast serverist. Soovitud keha ei ole vaja. Varukoopia ilmub nimekirjas pärast lõpetamist, mis võib võtta mitu minutit sõltuvalt kettakasutusest.

Nõutav luba: 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())

Näidisvastus

{
  "message": "Backup queued successfully"
}

Vastuse olekukoodid

200 Toiming järjekorda pandi
400 Serverit pole veel kasutusele võetud
402 Failis makseviisi ei kasutata või maksmata arveid ei esitata
404 Ei leitud või kuulub teisele kontole
SAA PATCH /api/v1/servers/{uuid}/backup-settings/

Ajasta automaatsed varukoopiad

Lülitab igapäevase või iganädalase automaatse varukoopia sisse või välja, sama seadistus, mis kontrollpaneelil on varukoopiate kaart. SAADA tagastab aktiivse ajakava. PÜÜGI (või PUT) muudab mõnda allpool toodud välja. Järjekorras olevate varukoopiate pööramine toimub kohe. Iga varukoopiat hoitakse alles 7 päeva.

Nõutav luba: servers:backup

enabledtrue käivitab automaatsed varukoopiad, mis on nende peatamiseks valed. Olemasolevaid varukoopiaid hoitakse kuni nende lõppemiseni.
planIga päev või nädalas. Varukoopiate maksumus on 30% (päeva) või 20% (nädalas) serveri plaanihinnast.
windowUTC tundi, mil varukoopia võib käivituda, näiteks algusjärgus 8-12. Aknad nagu 22-2 töötavad üle kesköö.
cURL
Python
curl -X PATCH "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/backup-settings/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true, "plan": "daily", "window": "8-12"}'
import requests

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

response = requests.patch(url, headers=headers, json={"enabled": True, "plan": "daily", "window": "8-12"})
print(response.json())

Näidisvastus

{
  "enabled": true,
  "plan": "daily",
  "window": "8-12",
  "retention_days": 7,
  "price_percent_of_plan": 30,
  "last_backup_at": "2026-10-28T23:33:50Z",
  "backups_kept": 1
}

Vastuse olekukoodid

200 Ajakava pärast mis tahes muudatusi
400 Vigane plaan või aken või server ei ole veel kasutusel
402 Failis makseviisi ei kasutata või maksmata arveid ei esitata
404 Ei leitud või kuulub teisele kontole
POST /api/v1/backups/{id}/restore/

Server taastatakse varukoopiast

Peatab serveri, kust varukoopia võeti, kirjutab selle ketta üle varukoopiaga ja käivitab selle uuesti. Serveri olek on järjekord, kui taastatakse.

Nõutav luba: 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"
}
Hoiatus: Kõik, mis on serverile kirjutatud pärast varukoopia tegemist, on kadunud. Taastamist ei saa tagasi võtta.

Vastuse olekukoodid

200 Toiming järjekorda pandi
400 Serverit pole veel kasutusele võetud
404 Ei leitud või kuulub teisele kontole

Märkused