VPS.org API

Dokumintaasje

Reservekopyen API

Jou jo tsjinner back- ups wer, begjin in nije back- up en herstel in tsjinner fan ien.

Einpunten 4
Basispaad /api/v1/backups
KRIJE /api/v1/backups/

List alle reservekopyen

Jout de reservekopyen fan al jo tsjinners werom, de lêste earst, 25 per side. Der is gjin tsjinnerfilter: brûk tsjinner_ hostnamme om se te groepearjen.

Tagongsrjochten fereaske: backups:list

Fraachparameters

Parameters Type Ferplicht Beskriuwing
page integer Net Sidenûmer, begjint by 1

Foarbyldfersyk

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

Foarbyldantwurd

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

Antwurdfjilden

Fjild Type Beskriuwing
id integer Reservekopy- identifikaasje, brûkt troch de einpunten foar opheljen en weromsetten
server_hostname string Hostnamme fan de tsjinner wêrfan de reservekopy makke is
name string Triemnamme fan reservekopy- archyf
size_gb number Komprimearre grutte yn gigabytes
deletion_date datetime Wannear de reservekopy automatysk fuortsmiten wurdt
days_remaining integer Folle dagen oer oant de datum fan fuortsmiten
created_at datetime Oanmaktiid (ISO 8601, UTC)

Antwurdstatuskoades

200 De reservekopylist is mei sukses ophelle
403 Untbrekkend of ûnjildich API-token, of it token hat net de fereaske tagongsrjochten
KRIJE /api/v1/backups/{id}/

In reservekopy ophelje

Jout ien reservekopyobjekt werom mei de boppesteande fjilden.

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

In reservekopy oanmeitsje

Stelt in reservekopy fan in ynset tsjinner yn de wachtrige. Gjin fersyk is nedich. De reservekopy ferskynt yn de list as it klear is, wat in pear minuten duorje kin ôfhinklik fan it skiifgebrûk.

Tagongsrjochten fereaske: 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())

Foarbyldantwurd

{
  "message": "Backup queued successfully"
}

Antwurdstatuskoades

200 De aksje is yn de wachtrige set
400 De tsjinner is noch net ynset
402 Gjin betellingsmethode yn triem, of net- betelle faktueren
404 Net fûn, of it heart by in oar akkount
POST /api/v1/backups/{id}/restore/

In tsjinner weromsette fanút in reservekopy

Stopt de tsjinner wêrfan de reservekopy makke is, oerskriuwt de skiif mei de reservekopy en begjint opnij. Gjin fersyk is nedich. De tsjinnertastân is yn de wachtrige wylst it weromsetten rint.

Tagongsrjochten fereaske: 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"
}
Warskôging: Alles wat nei de tsjinner skreaun is nei' t de reservekopy makke is, is ferlern. In weromsetten kin net ûngedien makke wurde.

Antwurdstatuskoades

200 De aksje is yn de wachtrige set
400 De tsjinner is noch net ynset
404 Net fûn, of it heart by in oar akkount

Notysje