VPS.org API

ເອກະສານ REST API

API ສະແນັບຊັອດ

ຖ່າຍ​ຮູບ​ສະຕັອກ​ຂອງ​ເຊີບເວີ​ທີ່​ມີ​ຊື່, ລາຍຊື່​ພວກ​ມັນ ແລະ ເອົາ​ອອກ​ຈາກ​ທີ່​ທ່ານ​ບໍ່​ຕ້ອງການ​ອີກ​ຕໍ່ໄປ.

ຈຸດສິ້ນສຸດ 4
ເສັ້ນທາງພື້ນຖານ /api/v1/snapshots
ຮັບ /api/v1/snapshots/

ລາຍຊື່ Snapshot ທັງໝົດ

ສົ່ງ​ຄືນ​ຮູບ​ຖ່າຍ​ໃນ​ບັນຊີ​ຂອງທ່ານ, ໃກ້​ສຸດ​ກ່ອນ, 25 ຕໍ່​ໜ້າ.

ຕ້ອງການ​ສິດ​ອຳນາດ: snapshots:list

ຕົວຢ່າງການຮ້ອງຂໍ

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

ຕົວຢ່າງການຕອບສະໜອງ

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

ພາກສະໜາມຕອບສະໜອງ

​ແຄມ​ເປນ ປະເພດ ຄໍາອະທິບາຍ
uuid string ຕົວ​ລະບຸ​ຮູບ​ຖ່າຍ (32 ຕົວ​ອັກສອນ hex, ບໍ່ມີ​ຕົວ​ຢຽບ)
label string ຊື່​ທີ່​ໄດ້​ໃຫ້​ເມື່ອ​ໄດ້​ສ້າງ​ຮູບ​ຖ່າຍ
server_hostname string ຊື່​ເຄື່ອງ​ຂອງ​ເຄື່ອງ​ຮັບ​ທີ່​ໄດ້​ຖ່າຍ​ຮູບ​ຖ່າຍ​ຈາກ ຫຼື ບໍ່​ມີ ຖ້າ​ເຄື່ອງ​ຮັບ​ນັ້ນ​ບໍ່​ມີ​ຢູ່​ອີກ
ready boolean ຖືກ​ເມື່ອ​ຖ່າຍ​ພາບ​ໄດ້​ສຳເລັດ
deleting boolean ຕົວຈິງ ໃນຂະນະທີ່ການລຶບກຳລັງດຳເນີນ
created_at datetime ເວລາ​ສ້າງ (ISO 8601, UTC)
size_gb number ຂະໜາດ​ທີ່​ໄດ້​ບີບອັດ​ເປັນ​ຈີ​ກາ​ບິດ
ຮັບ /api/v1/snapshots/{uuid}/

ຖ່າຍ​ຮູບ​ທັນທີ

ສົ່ງ​ຄືນ​ສິ່ງ​ທີ່​ຖ່າຍ​ພາບ​ຖ່າຍ​ກັບ​ແຫລ່ງ​ຂໍ້ມູນ​ຂ້າງ​ເທິງ​ນີ້​ຄືນ​ມາ​ໄດ້​ອີກ​ຄັ້ງ​ໜຶ່ງ ។ ໃຊ້​ມັນ​ເພື່ອ​ສອບຖາມ​ຄວາມ​ພ້ອມ​ຫຼັງ​ຈາກ​ສ້າງ​ຮູບ​ຖ່າຍ​ແລ້ວ ។

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

ສ້າງ​ຮູບ​ຖ່າຍ

ຈັດເປັນ​ຊ່ອງ​ລໍຖ້າ​ຮູບ​ຖ່າຍ​ຂອງ​ເຄື່ອງ​ບໍລິການ​ທີ່​ໄດ້​ຈັດ​ຕັ້ງ​ໄວ້ ແລະ ສົ່ງ​ຄືນ uuid ຂອງ​ຮູບ​ຖ່າຍ​ໃໝ່. ຮູບ​ຖ່າຍ​ຈະ​ຖືກ​ລາຍ​ງານ​ທັນທີ​ດ້ວຍ​ການ​ຕັ້ງ​ຄ່າ ready ເປັນ false.

ຕ້ອງການ​ສິດ​ອຳນາດ: servers:snapshot

ຮ້ອງຂໍພາລາມິເຕີຂອງຮ່າງກາຍ

ຕົວ​ເລືອກ​ ປະເພດ ຕ້ອງມີການ ຄໍາອະທິບາຍ
action string ແມ່ນແລ້ວ ຕ້ອງ​ເປັນ​ຮູບ​ຖ່າຍ
snapshot_label string ແມ່ນແລ້ວ ຊື່​ທີ່​ຈະ​ໃຊ້​ເພື່ອ​ຮັບ​ຮູ້​ພາບຖ່າຍ
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"])

ຕົວຢ່າງການຕອບສະໜອງ

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

ລະຫັດສະຖານະການຕອບສະໜອງ

200 ການກະທໍາ​ຖືກ​ຈັດ​ເປັນ​ລໍາດັບ
400 ຂາດ action ຫຼື snapshot_label ຫຼື ເຊີເວີ​ຍັງບໍ່ໄດ້​ເປີດໃຊ້
402 ບໍ່ມີ​ວິທີ​ຈ່າຍ​ໃນ​ໄຟລ໌ ຫຼື ໃບ​ເກັບ​ເງິນ​ທີ່​ບໍ່​ໄດ້​ຈ່າຍ
404 ບໍ່ພົບ ຫຼື ມັນເປັນສ່ວນຂອງບັນຊີອື່ນ
ລຶບ /api/v1/snapshots/{uuid}/

ເອົາ​ຮູບ​ຖ່າຍ​ອອກ

ຈັດຮູບຖ່າຍ​ໄວ້​ໃນ​ແຖບ​ລໍຖ້າ ເພື່ອ​ລຶບ​ໄວ້​ຕະຫຼອດ​ໄປ. ການ​ລຶບ​ແມ່ນ​ເປັນ​ຈິງ ຈົນໄປ​ຮອດ​ມັນ​ຫາຍ​ໄປ.

ຕ້ອງການ​ສິດ​ອຳນາດ: snapshots:delete

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

ລະຫັດສະຖານະການຕອບສະໜອງ

202 ຍອມຮັບ: ຄໍາຮ້ອງຂໍ​ໄດ້​ຖືກ​ຈັດ​ເປັນ​ລໍາດັບ
404 ບໍ່ພົບ ຫຼື ມັນເປັນສ່ວນຂອງບັນຊີອື່ນ

ບັນທຶກ