VPS.org API

Dokumentimi i API REST

API-ja e pamjeve të çastit

Merr foto të etiketuara të një serveri, listoje ato dhe elemino ato që nuk i ke më nevojë.

Pikat fundore 4
Shtegu Bazë /api/v1/snapshots
MERR /api/v1/snapshots/

Listo të gjitha pamjet e çastit

Kthen fotot e llogarisë suaj, më të reja në fillim, 25 për faqe.

Të drejta të nevojshme: snapshots:list

Shembull Kërkese

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

Shembull Përgjigjeje

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

Fushat e Përgjigjes

Fusha Lloji Përshkrimi
uuid string Identifikuesinstanties (32 karaktere hexadecimal, pa vijëza)
label string Etiketa e dhënë kur është krijuar pika
server_hostname string Emri i host të serverit nga i cili është marrë imazhi, ose null nëse serveri nuk ekziston më
ready boolean E vërtetë kur fotoja të përfundojë
deleting boolean E vërtetë ndërsa një eleminim është në proces
created_at datetime Ora e krijimit (ISO 8601, UTC)
size_gb number Madhësia e kompresuar në gigabyte
MERR /api/v1/snapshots/{uuid}/

Merr një foto

Kthen një objekt snapshot me fushat e sipërme. Përdoret për të pyetur gati pas krijimit të një snapshot.

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

Krijo një moment

Vendos në radhë një imazh të serverit të vendosur dhe kthen uuid të imazhit të ri. Imazhi shfaqet menjëherë me gatishmërinë e vendosur në false.

Të drejta të nevojshme: servers:snapshot

Parametrat e Trupit të Kërkesës

Parametrat Lloji E detyrueshme Përshkrimi
action string Po Duhet të jetë një foto
snapshot_label string Po Një etiketë për të identifikuar fotografinë
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"])

Shembull Përgjigjeje

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

Kodet e Statusit të Përgjigjes

200 Veprimi u vendos në rradhë
400 mungon action ose snapshot_label, ose serveri nuk është vendosur ende
402 Asnjë metodë pagese në file, apo faturat e papaguara
404 Nuk u gjet ose i përket një llogarie tjetër
FSHIR /api/v1/snapshots/{uuid}/

Elemino një imazh

Lidh në radhë instantanën për eleminimin e përhershëm. eleminimi është i vërtetë deri sa të zhduket.

Të drejta të nevojshme: snapshots:delete

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

Kodet e Statusit të Përgjigjes

202 U pranua: kërkesa u vendos në rradhë
404 Nuk u gjet ose i përket një llogarie tjetër

Shënim