VPS.org API

Documentazione REST API

API di e copie di salvezza

Elencari li backup dû servituri, accuminciari un novu backup e ripristinari un servituri da unu.

Punti finali 4
Percorsu di Base /api/v1/backups
OTTIENI /api/v1/backups/

Elencà tutte e copie di salvezza

Ritorna li backup di tutti li vostri servituri, u cchiù novu prima, 25 pi pagina. Nun ci hè filtru di servituri: usate server_hostname pi raggruppalli.

Permessi richiesti: backups:list

Parametri di dumanda

Parametri Tipu Obbligatoriu Descrizzioni
page integer No U numaru di pagina, a cuminciari di 1

Esempiu di dumanda

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

Esempiu di risposta

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

Campi di risposta

Campu Tipu Descrizzioni
id integer Identificaturi di backup, usatu di l'endpoints di ripristinu e ripigghiamentu
server_hostname string U nomu di l'òspiti dû servituri di cui fu presa a copia di sicurizza
name string Nome di l'archiviu di backup
size_gb number Dimensioni cumpressione in gigabytes
deletion_date datetime Quannu lu backup sarà rimossu automaticamenti
days_remaining integer Giorni interi mancanu finu a data_cancellazione
created_at datetime Ora di criazzioni (ISO 8601, UTC)

Codici di Statu di Risposta

200 Ricuperò a lista di backup
403 Token API mancante o nun validu, o u token nun havi li permessi richiesti
OTTIENI /api/v1/backups/{id}/

Riciviri na copia di sicurizza

Ritorna un oggettu di backup cu li campi supra.

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

Crea una copia di sicurizza

Fa a coda una copia di sicurizza di un servituri dispiegatu. Nudda richiesta di corpu è necessaria. A copia di sicurizza cumparirà ntâ lista una vota finita, chistu pò pigghiari qualchi minuti a sicunna di l'usu di u discu.

Permessi richiesti: 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())

Esempiu di risposta

{
  "message": "Backup queued successfully"
}

Codici di Statu di Risposta

200 L'azzioni fu messa 'n coda
400 U sirvitore nun è ancora dispiegatu
402 Nudda manera di pagà in archiviu, o fatture non pagate
404 Non truvatu, o appartiene a un altru contu
POST /api/v1/backups/{id}/restore/

Ripristina un servituri da una copia di sicurizza

Arrista lu servituri di cui fu presa la copia di sicurizza, suprascrivi lu discu cu la copia di sicurizza e lu riavvia. Nudda richiesta di corpu è necessaria. U statu dû servituri è in coda mentri u ripristinu è in esecuzzioni.

Permessi richiesti: 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"
}
Avvisu: Tuttu chiddu ca fu scrittu nnô sirvitori dopu a copia di sicurizza fu pirduta. Un ripristinu nun pò èssiri annullatu.

Codici di Statu di Risposta

200 L'azzioni fu messa 'n coda
400 U sirvitore nun è ancora dispiegatu
404 Non truvatu, o appartiene a un altru contu

Note