VPS.org API

REST API dokumentacija

API za posnetke

Vzemite označene posnetke strežnika, jih naštejte in izbrišite tiste, ki jih ne potrebujete več.

Končne točke 4
Osnovna pot /api/v1/snapshots
PRIDOBITE /api/v1/snapshots/

Seznam vseh posnetkov

Vrne posnetke na vašem računu, najnovejši prvi, 25 na stran.

Zahtevano dovoljenje: snapshots:list

Primer zahteve

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

Primer odgovora

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

Polja za odgovor

Polje Vrsta Opis
uuid string Identifikator posnetka (32 heksadecimalnih znakov, brez slikovnic)
label string Oznaka, navedena pri ustvarjanju posnetka
server_hostname string Ime strežnika, s katerim je bil posnetek posneten, ali ničla, če ta strežnik ne obstaja več
ready boolean Točno, ko se posnetek konča
deleting boolean Res je, medtem ko je črtanje v teku
created_at datetime Čas ustvarjanja (ISO 8601, UTC)
size_gb number Kompresirana velikost v gigabajtah
PRIDOBITE /api/v1/snapshots/{uuid}/

Snemanje snemanja

Vrne en posnetek predmet z zgornjimi polji. Uporabite ga za anketo pripravljen po ustvarjanju posnetka.

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

Ustvari posnetek

Vrne posnetek razporejenega strežnika in vrne uuid novega posnetka. Snemaček je naveden takoj in pripravljen nastavljen na napako.

Zahtevano dovoljenje: servers:snapshot

Zahtevajte parametre telesa

Parameter Vrsta Zahtevano Opis
action string Da Naj bi bila posnetek
snapshot_label string Da Nalepka za prepoznavanje posnetka po
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"])

Primer odgovora

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

Kode stanja odgovora

200 Ukrep je bil v vrsti
400 dejanja ali oznaka posnetka manjka ali strežnika še ni uporabljena
402 Brez načina plačila v datoteki ali neplačanih računih
404 Ni najden ali pripada drugemu računu
IZBRIŠI /api/v1/snapshots/{uuid}/

Zbriši posnetek

Postavi posnetek za trajno brisanje. Brisanje je resnično, dokler ni izginilo.

Zahtevano dovoljenje: snapshots:delete

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

Kode stanja odgovora

202 Sprejeto: zahtevek je bil v vrsti
404 Ni najden ali pripada drugemu računu

Opombe