VPS.org API

REST API Documentation

API yeBackups

List yako server backups, kutanga nyowani backup uye kudzoreredza server kubva kune imwe.

Magumo 4
Nzira Yekutanga /api/v1/backups
Tora /api/v1/backups/

Rondedzera Makopi Ese Ekuchengetedza

Inodzosera backups yese yako servers, nyowani yekutanga, 25 papeji. Hapana server filter: shandisa server_ hostname kuti uzviparadzanise.

Kuda mvumo: backups:list

Maparamita emibvunzo

Parameter Rudzi Zvinodiwa Kutaura
page integer Hapana Nhamba yepeji, inobva pa1

Muenzaniso weChikumbiro

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

Muenzaniso weMhinduro

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

Minda Yemhinduro

_Firi Rudzi Kutaura
id integer Backup identifier, used by the get and restore endpoints
server_hostname string Hostname yeserver iyo backup yakatora kubva
name string Backup archive file name
size_gb number Yakakomberedza upamhi mu gigabytes
deletion_date datetime Kana backup yaiswa otomatiki
days_remaining integer Whole days left until deletion_date
created_at datetime Kuumbwa kwenguva (ISO 8601, UTC)

Makodhi eMamiriro eMhinduro

200 Kubudirira kudzoreredza backup list
403 Kukanganisa kweAPI Token kana kuti Token haina mvumo yakakodzera
Tora /api/v1/backups/{id}/

Kuwana Backup

Reverses imwe backup chinhu nenzvimbo pamusoro.

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

Kugadzira backup

Kuisa mubhokisi backup ye server. Hapana chikumbiro chemuviri chinodarika. Backup inoonekwa mubhokisi rezvinyorwa kana yapera, izvo zvinogona kutora maawa akawanda zvichienderana nekushandisa kwe disk.

Kuda mvumo: 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())

Muenzaniso weMhinduro

{
  "message": "Backup queued successfully"
}

Makodhi eMamiriro eMhinduro

200 Chiito ichi chakanga chaiswa mubhokisi
400 Server haisi kuiswa
402 Hapana nzira yekubhadhara yakanyorwa, kana invoices dzisina kubhadharwa
404 Haichawanikwa, kana kuti inobva kune imwe account
POST /api/v1/backups/{id}/restore/

Kudzosera Server kubva kuBackup

Inomisa server iyo backup yakatora kubva, inonyora pamusoro pedisk yayo ne backup uye inotangazve. Hapana chikumbiro chemuviri chinodiwa. Server status icho chiri musoro kana kudzoreredza kuchienda.

Kuda mvumo: 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"
}
Kuzivisa: Zvese zvakanyorwa paseva mushure mekutora backup zvinorasikirwa. Kudzoreredza hakugone kugadziriswa.

Makodhi eMamiriro eMhinduro

200 Chiito ichi chakanga chaiswa mubhokisi
400 Server haisi kuiswa
404 Haichawanikwa, kana kuti inobva kune imwe account

Nhoroondo