VPS.org API

Dokumentazzjoni tal-REST API

API tal-Backups

Elenkar backups server tiegħek, tibda backup ġdid u jirrestawraw server minn wieħed.

Punti tat-tmiem 4
Mogħdija Bażika /api/v1/backups
IKSEB /api/v1/backups/

Elenka l-Backups Kollha

Jirritorna l-backups tas-servers kollha tiegħek, l-aktar ġdida l-ewwel, 25 għal kull paġna. M'hemm l-ebda filtru server: użu server_hostname biex grupp minnhom.

Permess meħtieġ: backups:list

Parametri tal-Mistoqsija

Parametru Tip Meħtieġ Deskrizzjoni
page integer Nru Numru tal-paġna, li jibda minn 1

Eżempju ta' Talba

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

Eżempju ta' Rispons

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

Oqsma ta' Rispons

Qasam Tip Deskrizzjoni
id integer Identifikatur tal-backup, użat mill-punti aħħarin tal-ġbir u r-restawr
server_hostname string Hostname tas-server il-backup kien meħud minn
name string Backup arkivju fajl isem
size_gb number Daqs ikkompressat f'gigabytes
deletion_date datetime Meta l-backup se jitneħħew awtomatikament
days_remaining integer Jiem sħaħ li fadal sa data_tħassir
created_at datetime Ħin tal-ħolqien (ISO 8601, UTC)

Kodiċijiet tal-Istatus tar-Rispons

200 Lista backup irkuprata b'suċċess
403 Token tal-API nieqes jew invalidu, jew it-token ma għandux il-permess meħtieġ
IKSEB /api/v1/backups/{id}/

Ikseb Backup

Jirritorna oġġett backup wieħed mal-oqsma hawn fuq.

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

Oħloq Backup

Jikkwota backup ta' server imħaddem. L-ebda korp ta' talba mhu meħtieġ. Il-backup jidher fil-lista ladarba jkun lest, li jista' jieħu diversi minuti skond l-użu tad-diska.

Permess meħtieġ: 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())

Eżempju ta' Rispons

{
  "message": "Backup queued successfully"
}

Kodiċijiet tal-Istatus tar-Rispons

200 L-azzjoni kienet fil-kju
400 Is-server għadu ma ġiex skjerat
402 Ebda metodu ta' ħlas fil-fajl, jew fatturi mhux imħallsa
404 Ma nstabx, jew jappartjeni għal kont ieħor
POST /api/v1/backups/{id}/restore/

Ir-restawr ta' Server minn Backup

Waqqaf is-server li minnu ttieħed il-backup, jikteb fuq id-diska tiegħu bil-backup u jerġa' jibda. L-ebda korp ta' talba mhu meħtieġ. L-istatus tas-server huwa fil-kju waqt li r-restawr ikun għaddej.

Permess meħtieġ: 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"
}
Twissija: Kollox miktub għall-server wara l-backup kien meħud huwa mitluf. A restawr ma jistgħux jiġu undone.

Kodiċijiet tal-Istatus tar-Rispons

200 L-azzjoni kienet fil-kju
400 Is-server għadu ma ġiex skjerat
404 Ma nstabx, jew jappartjeni għal kont ieħor

Noti