VPS.org API

REST API Documentation

Hetktõmmiste API

Võta serverist märgistatud pildid, loetle need ja kustuta need, mida sa enam ei vaja.

Lõpp-punktid 4
Baasrada /api/v1/snapshots
SAA /api/v1/snapshots/

Loetle kõik hetktõmmised

Tagastab teie kontol olevad pildid, uusim esimene, 25 lehekülje kohta.

Nõutav luba: snapshots:list

Näidistaotlus

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

Näidisvastus

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

Vastuseväljad

Väli Tüüp Description
uuid string Snapshot identifikaator (32 kuueteistkümnendikku märki, sidekriipsu puudub)
label string Pildi loomise ajal antud silt
server_hostname string Serveri masinanimi, kust pilt on võetud, või null, kui seda serverit enam ei ole
ready boolean Tõsi, kui pilt on lõpetatud
deleting boolean Tõsi, kui kustutamine käib.
created_at datetime Loomisaeg (ISO 8601, UTC)
size_gb number Tihendatud suurus gigabaitides
SAA /api/v1/snapshots/{uuid}/

Võta naps.

Tagastab ühe pildi objekti ülalolevate väljadega. Kasuta seda pärast pildi loomist valmis küsitluseks.

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

Loo pilt

Määrab valitud serverist pildi ja tagastab uue pildi uidid. See on ära toodud kohe, kui oled valmis valeks määrama.

Nõutav luba: servers:snapshot

Taotluse sisu parameetrid

Parameter Tüüp Nõutav Description
action string Jah Peab olema pilt
snapshot_label string Jah Sildi, mis võimaldab pildi ära tunda
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"])

Näidisvastus

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

Vastuse olekukoodid

200 Toiming järjekorda pandi
400 toiming või pilt_label puudub või server ei ole veel kasutusel
402 Failis makseviisi ei kasutata või maksmata arveid ei esitata
404 Ei leitud või kuulub teisele kontole
KUSTUTA /api/v1/snapshots/{uuid}/

Kustuta pilt

Määrab pildi püsivaks kustutamiseks. Kustutamine on tõene kuni selle kadumiseni.

Nõutav luba: snapshots:delete

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

Vastuse olekukoodid

202 Vastu võetud: taotlus oli järjekorras
404 Ei leitud või kuulub teisele kontole

Märkused