VPS.org API

เอกสาร REST API

API สแนปช็อต

เก็บภาพถ่ายของเซิร์ฟเวอร์ไว้ในรายการ และลบภาพที่คุณไม่ต้องการอีกต่อไป

จุดสิ้นสุด 4
เส้นทางฐาน /api/v1/snapshots
รับ /api/v1/snapshots/

แสดงภาพสแนปช็อตทั้งหมด

แสดงภาพถ่ายในบัญชีของคุณ โดยให้เลือกรูปภาพใหม่ก่อน จำนวน 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 ตัว ไม่มีตัวแยก)
label string แท็กที่ให้ไว้เมื่อสร้างภาพนิ่ง
server_hostname string ชื่อเครื่องของเซิร์ฟเวอร์ที่ใช้ถ่ายภาพนิ่ง หรือใช้ค่า null หากเซิร์ฟเวอร์นั้นไม่อยู่อีกต่อไป
ready boolean ถูกต้องเมื่อภาพถ่ายเสร็จสิ้น
deleting boolean ตั้งค่าเป็น True ขณะที่การลบกำลังดำเนินการอยู่
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 ไม่พบหรือว่าเป็นของบัญชีผู้ใช้อื่น

ข้อความ