VPS.org API

Dokumentácia REST API

Rozhranie API pre snímky

Vytvárajte označené snímky servera, vytvárajte zoznamy a odstraňujte tie, ktoré už nepotrebujete.

Koncové body 4
Základná cesta /api/v1/snapshots
ZÍSKAŤ /api/v1/snapshots/

Zobraziť všetky snímky

Vráti snímky vo vašom konte, najnovšie ako prvé, 25 na stranu.

Požadované povolenie: snapshots:list

Príklad žiadosti

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

Príklad odpovede

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

Polia odpovede

Pole Typ Opis
uuid string Identifikátor snímky (32 hexadecimálnych znakov, bez spojovníka)
label string Štítok zadaný pri vytvorení snímky
server_hostname string Názov servera, z ktorého bol snímok vytvorený, alebo null, ak server už neexistuje
ready boolean True po dokončení snímky
deleting boolean True, kým sa vykonáva odstránenie
created_at datetime Čas vytvorenia (ISO 8601, UTC)
size_gb number Komprimovaná veľkosť v gigabajtoch
ZÍSKAŤ /api/v1/snapshots/{uuid}/

Získať snímku

Vráti jeden snapshot objekt s poľami vyššie.Používa sa na poll ready po vytvorení snapshotu.

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

Vytvorenie snímky

Pridá snapshot nasadených serverov do frontu a vráti uuid nového snapshotu.Snapshot je hneď uvedený s ready nastaveným na false.

Požadované povolenie: servers:snapshot

Parametre tela požiadavky

Parameter Typ Povinné Opis
action string Áno Musí byť snapshot
snapshot_label string Áno Štítok na rozpoznanie snímky podľa
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"])

Príklad odpovede

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

Kódy stavu odpovede

200 Akcia bola zaradená do frontu
400 Chýba action alebo snapshot_label, alebo server ešte nie je nasadený
402 Žiadny spôsob platby v súbore alebo nezaplatené faktúry
404 Nenájdené, alebo patrí k inému účtu
ODSTRÁNIŤ /api/v1/snapshots/{uuid}/

Odstránenie snímky

Vytvára fronty snímok pre trvalé odstránenie. deleting je pravda, kým je preč.

Požadované povolenie: snapshots:delete

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

Kódy stavu odpovede

202 Prijaté: požiadavka bola zaradená do frontu
404 Nenájdené, alebo patrí k inému účtu

Poznámky