VPS.org API

Litokomane tsa REST API

Lifoto tsa Snapshot tsa API

Ntlafatsa lifoto tsa sebaka sa marang-rang, li hlophisa'me u tlose tseo u sa li hlokang.

Mafelo a ho Qetela 4
Tsela ea Motheo /api/v1/snapshots
FUMANA /api/v1/snapshots/

Thathamisa Lifoto Tsohle tse Khutšoanyane

E khutlisa lifoto tsa snapshot akhaonteng ea hau, tse ncha ka ho fetisisa pele, 25 ka leqephe.

Litokelo li hlokahale: snapshots:list

Kopo ea Mohlala

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

Karabo ea Mohlala

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

Masimo a Karabo

Setereke Mofuta Bophara
uuid string Mokhatlo oa snapshot (li-character tsa hex 32, ha ho na li-hyphens)
label string Lebitso le fanoeng ha setšoantšo se thehiloe
server_hostname string Lebitso la mofani oa sebaka sa marang-rang seo snapshot e nkang ho sona, kapa null haeba sebaka sa marang-rang se sa ntse se le teng
ready boolean Ho_la ha ho etsoa snapshot
deleting boolean Hoa 'nete ha ho e-na le ho tlosoa ho tsoelang pele
created_at datetime Nako ea ho theha (ISO 8601, UTC)
size_gb number Boholo ba ho kopanngoa ka gigabytes
FUMANA /api/v1/snapshots/{uuid}/

Tseba

E khutlisa ntho e le 'ngoe ea snapshot le libaka tse ka holimo. E sebelise ho etsa lipotso tse loketseng ka mor'a ho etsa snapshot.

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

E_ra setšoantšo

E beha ka sekoahelo se le seng snapshot ea sebatli se kentsoeng'me e khutlisa uuid ea snapshot e ncha. Snapshot e hlaha kapele ka ho e beha e le 'e loketseng' ho 'false'.

Litokelo li hlokahale: servers:snapshot

Kopa Liparamente tsa 'Mele

Parameter Mofuta E hlokahala Bophara
action string E E lokela ho ba snapshot
snapshot_label string E Letšoao la ho tsebahala ha snapshot ka lona
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"])

Karabo ea Mohlala

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

Likhoutu tsa Boemo ba Karabelo

200 Ts'ebetso e ne e le ka lebokoseng
400 action kapa snapshot_label e sa fumanehe, kapa setsi ha se na ho kenngoa
402 Ha ho na mokhoa oa ho lefa ka faele, kapa li-invoice tse sa lefisoeng
404 Ha e fumanehe, kapa e na le akhaonto e 'ngoe
Hlakola /api/v1/snapshots/{uuid}/

Cima un'immagine

E beha snapshot ka sekoahelo sa ho tlosoa ka ho sa feleng. ho tlosoa ho tla ba teng ho fihlela e tlosoa.

Litokelo li hlokahale: snapshots:delete

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

Likhoutu tsa Boemo ba Karabelo

202 E amohetse: kopo e kenngoa kapele
404 Ha e fumanehe, kapa e na le akhaonto e 'ngoe

Litlhaku