VPS.org API

REST API Documentation

Snapshots-API

Nehmen Sie beschriftete Snapshots eines Servers, listen Sie sie auf und löschen Sie die, die Sie nicht mehr benötigen.

Endpunkte 4
Basispfad /api/v1/snapshots
ERHALTEN /api/v1/snapshots/

Alle Snapshots auflisten

Gibt die Snapshots in Ihrem Konto zurück, die neuesten ersten, 25 pro Seite.

Erforderliche Genehmigung: snapshots:list

Beispielanfrage

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/snapshots/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/snapshots/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for snapshot in response.json()["results"]:
    print(snapshot["uuid"], snapshot["label"], snapshot["ready"])
const response = await fetch('https://admin.vps.org/api/v1/snapshots/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

Beispielantwort

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b",
      "label": "before-upgrade",
      "server_hostname": "web-01",
      "ready": true,
      "deleting": false,
      "created_at": "2026-09-14T18:30:00.000000Z",
      "size_gb": 3.4
    }
  ]
}

Antwortfelder

Feld Typ Description
uuid string Snapshot-Kennung (32 hexadezimale Zeichen, keine Bindestriche)
label string Etikett angegeben, wenn der Snapshot erstellt wurde
server_hostname string Hostname des Servers der Snapshot wurde aus, oder null, wenn dieser Server nicht mehr existiert
ready boolean Stimmt, sobald der Snapshot beendet ist
deleting boolean Wahr, während eine Löschung im Gange ist
created_at datetime Erstellungszeit (ISO 8601, UTC)
size_gb number Komprimierte Größe in Gigabyte
ERHALTEN /api/v1/snapshots/{uuid}/

Snapshot abrufen

Gibt ein Snapshot-Objekt mit den oben genannten Feldern zurück. Verwenden Sie es, um nach dem Erstellen eines Snapshots bereit zu pollen.

curl -X GET "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
POST /api/v1/servers/{uuid}/snapshot/

Snapshot erstellen

Wartet einen Snapshot eines bereitgestellten Servers und gibt die Uuid des neuen Snapshots zurück. Der Snapshot wird sofort mit bereit gesetzter auf false aufgelistet.

Erforderliche Genehmigung: servers:snapshot

Anfragekörperparameter

Parameter Typ Erforderlich Description
action string Ja Muss snapshot sein
snapshot_label string Ja Ein Etikett, um den Snapshot zu erkennen von
cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/snapshot/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action": "snapshot", "snapshot_label": "before-upgrade"}'
import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/snapshot/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
data = {"action": "snapshot", "snapshot_label": "before-upgrade"}

response = requests.post(url, headers=headers, json=data)
print(response.json()["snapshot_uuid"])

Beispielantwort

{
  "message": "Snapshot queued successfully",
  "snapshot_uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b"
}

Antwortstatuscodes

200 Die Aktion wurde in die Warteschlange gesetzt.
400 Aktion oder Snapshot_label fehlt, oder der Server wird noch nicht bereitgestellt
402 Keine Zahlungsmethode in der Akte oder unbezahlte Rechnungen
404 Nicht gefunden, oder es gehört zu einem anderen Konto
LÖSCHEN /api/v1/snapshots/{uuid}/

Snapshot löschen

Wartet den Snapshot für das permanente Löschen. Löschen ist wahr, bis er weg ist.

Erforderliche Genehmigung: snapshots:delete

curl -X DELETE "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Snapshot deletion queued"
}

Antwortstatuscodes

202 Akzeptiert: die Anfrage wurde in die Warteschlange gestellt
404 Nicht gefunden, oder es gehört zu einem anderen Konto

Anmerkungen