VPS.org API

Ukufaka idokhumende

I-Snapshots API

Thola izithonjana ezibhalwe ngegama zeseva, hlela futhi cima okunye ongakudinga.

Amaphoyinti Okugcina 4
Indlela Eyisisekelo /api/v1/snapshots
THOLA /api/v1/snapshots/

Bhala Zonke Izifinyezo

Ibuyisela izithombe ezingenalutho kwi-akhawunti yakho, ezisha kuqala, 25 ngakhasi.

Igunya elidingekayo: snapshots:list

Isicelo Sesibonelo

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 Yesibonelo

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

Izinkambu Zempendulo

Isigaba Uhlobo Incazelo
uuid string Isibonisi sesithombe esikhawulelwe (izimpawu ze-hexadecimal ezingu-32, akukho izihluzi)
label string Isihloko esinikeziwe lapho isithombe-skrini sidalwa
server_hostname string Igama lomnini wesisebenzisi esithathwe kusithombe-skrini, noma i-null uma lesisebenzisi asikhona
ready boolean Iqiniso uma isithombe-skrini siqediwe
deleting boolean Iqiniso uma kususwa okuqhubekayo
created_at datetime Isikhathi sokudalwa (ISO 8601, UTC)
size_gb number Ubukhulu obucindezelwe ngama-gigabytes
THOLA /api/v1/snapshots/{uuid}/

Thola isithombe-skrini

Ibuyisela okuthile kwesithombe-skrini ngalezi zindawo eziphezulu. Sebenzisa ukubuza okulungile ngemuva kokwenza isithombe-skrini.

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

Dala isithombe-skrini

Ifaka isikhalazo esincane somhlinzeki ofakwe futhi ibuyisela uuid yesikhalazo esitsha. Isikhalazo sibhalwe ngokushesha nge-ready ibekwe ku-false.

Igunya elidingekayo: servers:snapshot

Cela Amapharamitha Omzimba

Amapharamitha Uhlobo Kuyadingeka Incazelo
action string Yebo Kudingeka kube yisithombe-skrini
snapshot_label string Yebo Isihloko sokwazisa isithombe-skrini
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 Yesibonelo

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

Amakhodi Esimo Sempendulo

200 Intshukumo ifakwe ebhokisini
400 action or snapshot_label missing, or the server is not deployed yet
402 Akukho indlela yokukhokha kwifayela, noma amafayela angakhokhwa
404 Ayitholakali, noma ikhona kwezinye i-akhawunti
SUSA /api/v1/snapshots/{uuid}/

Cima isithombe-skrini

Iphoqa isithombe-skrini sokucisha okuqhubekayo. ukucisha kulungile kuze kube sekuphele.

Igunya elidingekayo: snapshots:delete

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

Amakhodi Esimo Sempendulo

202 Ivunyelwe: isicelo sifakwe ebhokisini
404 Ayitholakali, noma ikhona kwezinye i-akhawunti

Amabhukwana