VPS.org API

REST API dokumentáció

Pillanatképek API

A felcímkézett fényképeket a kiszolgálóról, listázza és törölje azokat, amelyekre már nincs szüksége.

Végpontok 4
Alapút /api/v1/snapshots
KAP /api/v1/snapshots/

Összes pillanatkép listázása

Visszaadja a képeket a fiókjában, a legújabb első, 25 oldalonként.

Szükséges engedély: snapshots:list

Példa kérés

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

Példaválasz

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

Válaszmezők

Mező Típus Leírás
uuid string A kép azonosítója (32 hexadecimális karakter, kötőjel nélkül)
label string A fénykép készítésekor megadott címke
server_hostname string A kiszolgáló hostneve a fényképet a kiszolgálóról vette le, vagy érvénytelen, ha a szerver már nem létezik
ready boolean Igaz, amint a pillanatkép elkészült
deleting boolean Igaz, miközben a törlés folyamatban van
created_at datetime Teremtési idő (ISO 8601, UTC)
size_gb number Összenyomott méret gigabájtban
KAP /api/v1/snapshots/{uuid}/

Csinálj egy Snapshot-ot!

Visszaad egy pillanatkép objektumot a fenti mezők. Használja, hogy a szavazás kész után egy pillanatkép.

curl -X GET "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
HÓNAPPAL KÉSŐBB /api/v1/servers/{uuid}/snapshot/

Készíts egy Snapshot-ot

Egy telepített szerverről készít egy pillanatképet, és visszaadja az új pillanatkép nuidját. A pillanatképet azonnal fel kell sorolni, és kész a hamisra beállítani.

Szükséges engedély: servers:snapshot

Kérés törzsének paraméterei

Paraméter Típus Kívánt Leírás
action string Igen Biztos csak pillanatkép.
snapshot_label string Igen A címke, hogy felismerje a pillanatképet
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"])

Példaválasz

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

Válasz állapotkódok

200 Az akció sorba állt.
400 action or shotp_label hiányzik, vagy a kiszolgáló még nem telepített
402 Nincs fizetési mód az aktában, vagy kifizetetlen számlák
404 Nem található, vagy más számlához tartozik.
TÖRÖL /api/v1/snapshots/{uuid}/

Törölje a Csábító képet

A törlés a törlés pillanatképét adja meg. A törlés igaz, amíg el nem tűnik.

Szükséges engedély: snapshots:delete

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

Válasz állapotkódok

202 Elfogadva: a kérés sorba állt
404 Nem található, vagy más számlához tartozik.

Megjegyzések