VPS.org API

REST API dokumentacija

Atsarginių kopijų API

Išvardykite serverio atsargines kopijas, paleiskite naują atsarginę kopiją ir atkurkite serverį iš vienos.

Galutiniai taškai 4
Bazinis kelias /api/v1/backups
GAUTI /api/v1/backups/

Visų atsarginių kopijų sąrašas

Grąžina visų serverių atsargines kopijas, naujausias pirmas, 25 per puslapį. Nėra serverio filtro: naudokite serverio_hostname, kad grupuoti juos.

Reikalingas leidimas: backups:list

Užklausos parametrai

Parametras Tipas Privaloma Aprašymas
page integer Nr. Puslapio numeris, prasidedantis nuo 1

Prašymo pavyzdys

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

Atsakymo pavyzdys

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

Atsakymo laukai

Laukas Tipas Aprašymas
id integer Atsarginis identifikatorius, naudojamas gauti ir atkurti baigtis
server_hostname string Serverio, iš kurio buvo paimta atsarginė kopija, serverio vardas
name string Kopijuoti archyvo failo pavadinimą
size_gb number Suspaustas dydis gigabaitais
deletion_date datetime Kai atsarginė kopija bus pašalinta automatiškai
days_remaining integer Liko iki ištrynimo_date
created_at datetime Sukūrimo laikas (ISO 8601, UTC)

Atsakymo būsenos kodai

200 Sėkmingai išgautas atsarginių kopijų sąrašas
403 Trūksta arba netinkamas API žetonas, arba žetonas neturi reikiamo leidimo
GAUTI /api/v1/backups/{id}/

Gaukite atsarginę kopiją

Grąžina vieną atsarginį objektą su laukeliais aukščiau.

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

Sukurti atsarginę kopiją

Įdiegto serverio atsarginė kopija. Nėra reikalo. Kopijavimas pateikiamas sąraše, kai baigsis, o tai gali užtrukti kelias minutes, priklausomai nuo disko naudojimo.

Reikalingas leidimas: 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())

Atsakymo pavyzdys

{
  "message": "Backup queued successfully"
}

Atsakymo būsenos kodai

200 Veiksmas buvo įrašytas į eilę
400 Serveris dar neįdiegtas
402 Nėra mokėjimo būdo byloje, arba nesumokėtos sąskaitos faktūros
404 Nerasta, arba ji priklauso kitai paskyrai
Potvarkis /api/v1/backups/{id}/restore/

Atstatyti serverį iš atsarginės kopijos

Nutraukia serverį, iš kurio buvo paimta atsarginė kopija, perrašo jo diską atsargine kopija ir vėl pradeda jį. Nėra reikalo. Serverio būsena yra eilė, kol atkuriama.

Reikalingas leidimas: 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"
}
Įspėjimas: Viskas, kas parašyta serveriui po atsarginės kopijos paėmimo, yra prarasta. Atkurti neįmanoma.

Atsakymo būsenos kodai

200 Veiksmas buvo įrašytas į eilę
400 Serveris dar neįdiegtas
404 Nerasta, arba ji priklauso kitai paskyrai

Pastabos