VPS.org API

REST API Xuquuqda

Sawirrada API-ga

Qaado snapshots labelled server, liiska iyaga iyo tirtirka kuwa aad ka baxsan tahay.

Dhammaadka 4
Waddo Saldhig ah /api/v1/snapshots
HEL /api/v1/snapshots/

Liis garee Dhammaan Sawirrada

Ku soo laabtay snapshots xisaabtaada, ugu dambeeyay ee hore, 25 bogga.

Xuquuqda loo baahan yahay: snapshots:list

Codsi Tusaale ah

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

Jawaabta Tusaale

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

Goobaha Jawaabta

Isku-darka Nooca Tilmaamaha
uuid string aqoonyahanka snapshot (32 xarfaha hexadecimal, aan isku xigta)
label string Calaamadaha la siiyay markii sawirka la abuuray
server_hostname string Magaca martida ee server-ka sawirka laga qaaday, ama waa null haddii server-ka uusan weli jirin
ready boolean Run marka sawirka la dhammeeyo
deleting boolean Run halka tirtirka uu socday
created_at datetime Waqtiga abuurista (ISO 8601, UTC)
size_gb number Miisaanka la isku dhejiyay oo lagu sheegay gigabytes
HEL /api/v1/snapshots/{uuid}/

Ka hel sawir

Ku soo laabtay mid ka mid ah snapshot wax la goobaha kor ku xusan. U isticmaali si ay u codeeyaan diyaar ka dib markii abuuray snapshot.

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

Samee Sawir

Ku soo celiya snapshot server oo la soo saaray oo ku soo celiya snapshot cusub ee uuid. Snapshot waxaa la soo bandhigay si deg deg ah oo diyaar ah oo loo dhigay false.

Xuquuqda loo baahan yahay: servers:snapshot

Codso Cabbirrada Jirka

_Barnaamijyada Nooca Loo baahan yahay Tilmaamaha
action string Haa Waa in ay tahay sawir
snapshot_label string Haa Calaamado lagu aqoonsado sawirka
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"])

Jawaabta Tusaale

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

Koodhadhka Xaaladda Jawaab celinta

200 Falku waa la isku raacay
400 action ama snapshot_label ayaa maqan, ama server-ka weli lama soo bandhigin
402 Ma jiro habka lacag bixinta ee faylka, ama xisaabaadka aan la bixin
404 Ma la helin, ama waxay ka tirsan tahay xisaab kale
TIRTIR /api/v1/snapshots/{uuid}/

Dib u Dhig Sawirada

Ku soo bandhiga sawirka si loo tirtiro. tirtirka waa run ilaa ay ka tagtay.

Xuquuqda loo baahan yahay: snapshots:delete

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

Koodhadhka Xaaladda Jawaab celinta

202 Aqbalay: codsiga waxaa la soo xiray
404 Ma la helin, ama waxay ka tirsan tahay xisaab kale

Xigasho