VPS.org API

เอกสาร REST API

API การสำรองข้อมูล

แสดงรายการการแบ็คอัพเซิร์ฟเวอร์ของคุณ เริ่มการแบ็คอัพใหม่ และเรียกคืนเซิร์ฟเวอร์จากเซิร์ฟเวอร์เดิม

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

แสดงรายการสำรองข้อมูลทั้งหมด

แสดงผลการสำรองข้อมูลของเซิร์ฟเวอร์ทั้งหมด โดยเริ่มจากรุ่นใหม่สุด จำนวน 25 หน้าต่อหน้า ไม่มีตัวกรองเซิร์ฟเวอร์: ใช้ server_ hostname เพื่อจัดกลุ่ม

ต้องการสิทธิ์: backups:list

พารามิเตอร์การค้นหา

พารามิเตอร์ พิมพ์ ที่จำเป็น คำอธิบาย
page integer ไม่มี หมายเลขหน้า เริ่มที่ 1

ตัวอย่างคำขอ

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for backup in response.json()["results"]:
    print(backup["id"], backup["server_hostname"], backup["created_at"])
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

ตัวอย่างคำตอบ

{
  "count": 96,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [
    {
      "id": 5512,
      "server_hostname": "web-01",
      "name": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
      "size_gb": 3.12,
      "deletion_date": "2026-09-21T20:45:40.697512Z",
      "days_remaining": 6,
      "created_at": "2026-09-14T20:45:40.699494Z"
    }
  ]
}

ช่องตอบกลับ

ช่อง พิมพ์ คำอธิบาย
id integer ตัวระบุการสำรองข้อมูล ใช้โดยการรับและคืนค่าจุดจบ
server_hostname string ชื่อเครื่องของเซิร์ฟเวอร์ที่ใช้ทำการสำรองข้อมูล
name string ชื่อแฟ้มสำรองข้อมูล
size_gb number ขนาดที่บีบอัดไว้ในกิกะไบต์
deletion_date datetime เมื่อไหร่ที่แฟ้มสำรองข้อมูลจะถูกลบออกโดยอัตโนมัติ
days_remaining integer จำนวนวันที่เหลือจนถึงวันที่ลบ
created_at datetime เวลาที่สร้าง (ISO 8601, UTC)

รหัสสถานะการตอบกลับ

200 เรียกรายการสำรองข้อมูลได้สำเร็จ
403 ไม่มีหรือไม่สามารถใช้ API token ได้ หรือ token นั้น ไม่มีสิทธิ์ที่จำเป็น
รับ /api/v1/backups/{id}/

ดาวน์โหลดข้อมูลสำรองข้อมูล

คืนค่ากลับมาเป็นตัวอย่างของข้อมูลสำรองข้อมูลที่ใช้กับช่องข้อมูลด้านบน

curl -X GET "https://admin.vps.org/api/v1/backups/5512/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
ข้อความ /api/v1/servers/{uuid}/backup/

สร้างแฟ้มสำรองข้อมูล

จัดให้มีการจัดคิวการสำรองข้อมูลของเซิร์ฟเวอร์ที่ติดตั้งไว้ โดยไม่ต้องใช้ส่วนร่างของคำขอ การสำรองข้อมูลจะปรากฏในรายการเมื่อเสร็จสิ้น ซึ่งอาจใช้เวลาหลายนาที ขึ้นอยู่กับการใช้งานดิสก์

ต้องการสิทธิ์: servers:backup

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/backup/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/backup/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

ตัวอย่างคำตอบ

{
  "message": "Backup queued successfully"
}

รหัสสถานะการตอบกลับ

200 การกระทำถูกจัดคิวไว้
400 ยังไม่มีการจัดตั้งเซิร์ฟเวอร์
402 ไม่มีวิธีการชำระเงินในแฟ้ม หรือไม่มีบัญชีเงินฝากที่ชำระแล้ว
404 ไม่พบหรือว่าเป็นของบัญชีผู้ใช้อื่น
ข้อความ /api/v1/backups/{id}/restore/

เรียกคืนเซิร์ฟเวอร์จากแฟ้มสำรองข้อมูล

หยุดเซิร์ฟเวอร์ที่ใช้ทำการสำรองข้อมูล จากนั้น เขียนทับแผ่นดิสก์ด้วยข้อมูลการสำรองข้อมูล และเริ่มการทำงานใหม่ โดยไม่ต้องใช้ส่วนร่างของคำขอ สถานะของเซิร์ฟเวอร์คือ คิว ขณะที่การเรียกคืนกำลังทำงานอยู่

ต้องการสิทธิ์: backups:restore

curl -X POST "https://admin.vps.org/api/v1/backups/5512/restore/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Backup restore queued. The server will be stopped, restored, and restarted.",
  "backup": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
  "job_id": "b6f1c7e2-3a4d-4f5e-8b9c-0d1e2f3a4b5c"
}
คำเตือน: ทุกอย่างที่เขียนลงไปในเซิร์ฟเวอร์หลังจากการสำรองข้อมูลจะหายไป การคืนค่าจะไม่สามารถทำซ้ำได้

รหัสสถานะการตอบกลับ

200 การกระทำถูกจัดคิวไว้
400 ยังไม่มีการจัดตั้งเซิร์ฟเวอร์
404 ไม่พบหรือว่าเป็นของบัญชีผู้ใช้อื่น

ข้อความ