VPS.org API

REST API dokumentasyon

Mga Snapshot API

Kumuha ng labelled snapshots ng isang server, listahan ang mga ito at tanggalin ang mga hindi mo na kailangan.

Mga Endpoint 4
Landas ng Batayan /api/v1/snapshots
KUMUHA /api/v1/snapshots/

Ilista ang Lahat ng Snapshot

Bumalik ang mga snapshot sa iyong account, pinakabagong unang, 25 bawat pahina.

Kailangang pahintulot: snapshots:list

Halimbawang Kahilingan

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

Halimbawang Tugon

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

Mga Patlang ng Tugon

Patlang Uri Paglalarawan
uuid string Snapshot identifier (32 hexadecimal character, walang hyphens)
label string Label ibinigay kapag ang snapshot ay nilikha
server_hostname string <hostname> Ang hostname ng server na ang snapshot ay kinuha mula sa, o null kung server na hindi na umiiral
ready boolean True kapag ang snapshot ay natapos na
deleting boolean True habang ang isang pagtanggal ay sa progreso
created_at datetime Oras ng paglikha (ISO 8601, UTC)
size_gb number Compressed laki sa gigabytes
KUMUHA /api/v1/snapshots/{uuid}/

Kumuha ng isang snapshot

Bumalik ng isang snapshot bagay sa mga patlang sa itaas. Gamitin ito upang poll handa pagkatapos ng paglikha ng isang snapshot.

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

Lumikha ng isang snapshot

Queues isang snapshot ng isang deployed server at bumalik ang bagong snapshot ng uuid. Ang snapshot ay nakalista agad na may handa na itakda sa false.

Kailangang pahintulot: servers:snapshot

Humiling ng mga Parameter ng Katawan

Parameter Uri Kinakailangan Paglalarawan
action string Oo Dapat ay snapshot
snapshot_label string Oo Isang label upang makilala ang snapshot sa pamamagitan ng
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"])

Halimbawang Tugon

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

Mga Kodigo ng Katayuan ng Tugon

200 Ang aksyon ay naka-queue
400 aksyon o snapshot_label nawawala, o ang server ay hindi deployed pa
402 Walang paraan ng pagbabayad sa file, o hindi nababayaran invoice
404 Hindi natagpuan, o ito ay pag-aari ng iba pang account
TANGGALIN /api/v1/snapshots/{uuid}/

Mag-edit ng isang snapshot

Ang mga ito ay maaaring maging permanente o pansamantalang, depende sa kung ano ang nais mong gawin.

Kailangang pahintulot: snapshots:delete

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

Mga Kodigo ng Katayuan ng Tugon

202 Tinanggap: ang kahilingan ay naka-queue
404 Hindi natagpuan, o ito ay pag-aari ng iba pang account

Mga tala