VPS.org API

Uxwebhu lwe-REST API

Iifoto ze-Snapshots API

Thatha imifanekiso eqingqiweyo ephawulwe ngegama yomncedisi, uluhlu lwazo kwaye cime ezo awuzifunayo.

Iindawo zokugqibela 4
Indlela Esisiseko /api/v1/snapshots
FUMANA /api/v1/snapshots/

Dwelisa Zonke Iifoto Ezifutshane

Ibuyisela imifanekiso ekhawulezayo kwi akhawunti yakho, entsha kuqala, 25 kwiphepha ngalinye.

Iimvume ezifunekayo: snapshots:list

Isicelo somzekelo

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

Impendulo yoMzekelo

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

IiNdawo zeMpendulo

Iindawo Uhlobo Inkcazelo
uuid string Isichazi sefoto ekhawulezayo (iimpawu ezi-32 ze hexadecimal, akukho ziqhoboshi)
label string I-label enikezelwe xa i-snapshot yakhiwa
server_hostname string Igama lomququzeleli weseva apho imifanekiso eqingqiweyo ithathwe khona, okanye ayisebenzi ukuba le seva ayikho
ready boolean Inyaniso xa umfanekiso okhawulezayo ugqityiwe
deleting boolean Yinyani xa ucima kuqhubeka
created_at datetime Ixesha lokuvelisa (ISO 8601, UTC)
size_gb number Ubungakanani obucinezelweyo kwi-gigabytes
FUMANA /api/v1/snapshots/{uuid}/

Fumana umfanekiso okhawulezayo

Ibuyisela enye into ye snapshot enemihlaba ephezulu. Sebenzisa ukubuza ilungile emva kokwenza i snapshot.

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

Dala umfanekiso ongumqondiso

Ifoloza umfanekiso okhawulezayo wesincedisi esinikezelwe kwaye ibuyisela uuid wesithombe esikhawulezayo esitsha. Umfanekiso okhawulezayo udweliswe ngokuzenzekelayo nge-ready imiselwe ukuba yi-false.

Iimvume ezifunekayo: servers:snapshot

Cela iiParamitha zoMzimba

Iparamitha Uhlobo Kufuneka Inkcazelo
action string Ewe Kufuneka ibe yifoto yexesha elizayo
snapshot_label string Ewe I-label yokuqwalasela umfanekiso okhawulezayo
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"])

Impendulo yoMzekelo

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

Iikhowudi zeMeko yokuphendula

200 Intshukumo ifolokhwe
400 action or snapshot_label missing, or the server is not deployed yet
402 Akukho ndlela yohlawula kwifayili, okanye iinfaktura ezingahlawulwanga
404 Ayifumanekanga, okanye imalunga ne-akhawunti enye
CIMA /api/v1/snapshots/{uuid}/

Cima umfanekiso ongumqondiso

Ifoloza umfanekiso okhawulezayo ukucima ngokusisigxina. ukucima kuyinyaniso de kube sele iphelile.

Iimvume ezifunekayo: snapshots:delete

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

Iikhowudi zeMeko yokuphendula

202 Ivunyiwe: isicelo sifolonyelwa
404 Ayifumanekanga, okanye imalunga ne-akhawunti enye

Iinkcukacha