VPS.org API

REST API Documentation

Backups-API

Liste deine Server-Backups auf, starte ein neues Backup und wiederherstellen einen Server von einem.

Endpunkte 4
Basispfad /api/v1/backups
ERHALTEN /api/v1/backups/

Alle Backups auflisten

Gibt die Sicherungen aller Server zurück, die erst 25 pro Seite sind. Es gibt keinen Serverfilter: Verwenden Sie server_hostname, um sie zu gruppieren.

Erforderliche Genehmigung: backups:list

Abfrageparameter

Parameter Typ Erforderlich Description
page integer No Seitennummer, beginnend bei 1

Beispielanfrage

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

Beispielantwort

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

Antwortfelder

Feld Typ Description
id integer Backup-Identifikator, verwendet von den get und wiederherstellen Endpunkte
server_hostname string Hostname des Servers wurde das Backup aus
name string Dateiname des Archivs sichern
size_gb number Komprimierte Größe in Gigabyte
deletion_date datetime Wenn das Backup automatisch entfernt wird
days_remaining integer Ganze Tage bis zum Löschen_date
created_at datetime Erstellungszeit (ISO 8601, UTC)

Antwortstatuscodes

200 Erfolgreich abgerufene Backup-Liste
403 Fehlendes oder ungültiges API-Token oder dem Token fehlt die erforderliche Berechtigung
ERHALTEN /api/v1/backups/{id}/

Sichern Sie sich ein Backup

Gibt ein Sicherungsobjekt mit den oben genannten Feldern zurück.

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

Backup erstellen

Wartet auf eine Sicherung eines bereitgestellten Servers. Es wird kein Request-Körper benötigt. Das Backup erscheint in der Liste, sobald es fertig ist, was je nach Festplattennutzung mehrere Minuten dauern kann.

Erforderliche Genehmigung: 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())

Beispielantwort

{
  "message": "Backup queued successfully"
}

Antwortstatuscodes

200 Die Aktion wurde in die Warteschlange gesetzt.
400 Der Server ist noch nicht installiert
402 Keine Zahlungsmethode in der Akte oder unbezahlte Rechnungen
404 Nicht gefunden, oder es gehört zu einem anderen Konto
POST /api/v1/backups/{id}/restore/

Wiederherstellen eines Servers aus einem Backup

Stoppt den Server, von dem das Backup genommen wurde, überschreibt seine Festplatte mit dem Backup und startet es erneut. Es wird kein Request Body benötigt. Der Serverstatus ist Warteschlange, während die Wiederherstellung läuft.

Erforderliche Genehmigung: 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"
}
Warnung: Alles, was nach dem Backup auf den Server geschrieben wurde, ist verloren. Eine Wiederherstellung kann nicht rückgängig gemacht werden.

Antwortstatuscodes

200 Die Aktion wurde in die Warteschlange gesetzt.
400 Der Server ist noch nicht installiert
404 Nicht gefunden, oder es gehört zu einem anderen Konto

Anmerkungen