VPS.org API

REST API dokumentacija

Momentinių kopijų API

Imtis pažymėtų serverio vaizdajuosčių, jas išvardyti ir ištrinti nebereikalingas.

Galutiniai taškai 4
Bazinis kelias /api/v1/snapshots
GAUTI /api/v1/snapshots/

Išvardinti visas momentines nuotraukas

Grąžina savo paskyros vaizdai, naujausias pirmas, 25 puslapyje.

Reikalingas leidimas: snapshots:list

Prašymo pavyzdys

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

Atsakymo pavyzdys

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

Atsakymo laukai

Laukas Tipas Aprašymas
uuid string Snapshot identifikatorius (32 šešioliktainės simbolių, be hifenų)
label string Žyma, kai buvo sukurtas momentuotė
server_hostname string Serverio, iš kurio buvo paimta fotografija, serverio vardas arba nulinis, jei serveris nebeegzistuoja
ready boolean Tikra, kai tik momentuotė baigsis
deleting boolean Tiesa, kol vyksta dalinio ištrynimo procesas
created_at datetime Sukūrimo laikas (ISO 8601, UTC)
size_gb number Suspaustas dydis gigabaitais
GAUTI /api/v1/snapshots/{uuid}/

Nufotografuoti

Grąžina vieną vaizdajuostę su laukeliais. Naudokite juos, kad apklaustų, po to, kai sukūrėte vaizdajuostę.

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

Sukurti fotografiją

Įrašykite įkelto serverio nuotrauką ir grąžinkite naujos vaizdajuostės uuid. Scenarijus pateikiamas iš karto su paruoštu nustatymu klaidingai.

Reikalingas leidimas: servers:snapshot

Užklausos turinio parametrai

Parametras Tipas Privaloma Aprašymas
action string Taip Turi būti momentuotė
snapshot_label string Taip Etiketė, kuri atpažįsta momentą pagal
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"])

Atsakymo pavyzdys

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

Atsakymo būsenos kodai

200 Veiksmas buvo įrašytas į eilę
400 trūksta veiksmo ar momento_žymos, arba serveris dar nėra įdiegtas
402 Nėra mokėjimo būdo byloje, arba nesumokėtos sąskaitos faktūros
404 Nerasta, arba ji priklauso kitai paskyrai
IŠTRINTI /api/v1/snapshots/{uuid}/

Pašalinti fotografiją

Ištrina vaizdajuostę visam laikui. Ištrinti, kol ji išnyksta.

Reikalingas leidimas: snapshots:delete

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

Atsakymo būsenos kodai

202 Priimta: prašymas buvo įrašytas į eilę
404 Nerasta, arba ji priklauso kitai paskyrai

Pastabos