เอกสาร VPS API: REST API สำหรับสร้างและจัดการเซิร์ฟเวอร์

สิ่งที่ทำได้ด้วย API

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

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

ที่อยู่หลัก

ทุกคำขอส่งโดยต่อพาธท้ายที่อยู่ด้านล่าง เนื้อหาคำขอและการตอบกลับเป็น JSON (UTF-8) ทั้งหมด

https://helpervps.com/api/v1

การยืนยันตัวตน

ส่งส่วนหัว Authorization: Bearer YOUR_API_KEY คุณสามารถสร้างคีย์ได้จากเมนูคีย์ API ในบัญชีของคุณหลังจากการชำระเงินครั้งแรก คีย์จะขึ้นต้นด้วย hvp_ คีย์จะแสดงแบบเต็มเพียงครั้งเดียวทันทีหลังสร้าง และเมื่อสร้างคีย์ใหม่ คีย์เดิมจะใช้งานไม่ได้ทันที

curl https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

ขีดจำกัดคำขอ

รหัสเซิร์ฟเวอร์

เซิร์ฟเวอร์ระบุด้วยรหัสเซิร์ฟเวอร์ เช่น S-7K2M-9QX4-HB3T แทนหมายเลข ใส่ค่า id จากรายการเซิร์ฟเวอร์หรือจากการตอบกลับตอนสร้างลงในพาธได้เลย ไม่แยกตัวพิมพ์ใหญ่และเล็ก

GET /catalog

ส่งคืนสเปกที่เปิดขาย (plans) ภูมิภาค (locations) อิมเมจ (images) และตัวเลือกเสริม (addons) ในครั้งเดียว รหัสทั้งหมดที่ใช้ตอนสร้างเซิร์ฟเวอร์มาจากที่นี่ monthly คือค่าบริการรายเดือนเป็นดอลลาร์สหรัฐ ตัวเลือกที่ไม่ได้เปิดขายจะเป็น null และ monthly_per_gb ของดิสก์เสริมแสดงทศนิยมสามตำแหน่ง

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

curl https://helpervps.com/api/v1/catalog \
  -H "Authorization: Bearer YOUR_API_KEY"

ตัวอย่างการตอบกลับ

{
  "plans": [
    { "code": "s2", "type": "basic", "vcpu": 1, "ram_mb": 2048, "disk_gb": 50, "transfer_tb": 2, "monthly": "2.48" }
  ],
  "locations": ["frankfurt", "singapore", "seoul"],
  "images": ["ubuntu-24-04", "debian-13", "almalinux-10", "app-docker"],
  "addons": {
    "backups": { "percent_of_plan": 5.6 },
    "extra_disk": { "sizes_gb": [50, 100, 250, 500, 1000], "monthly_per_gb": "0.028" },
    "ddos_protection": { "monthly": "1.68" }
  }
}

GET /servers

ส่งคืนรายการเซิร์ฟเวอร์ของคุณเรียงจากที่สร้างล่าสุด ไม่รวมเซิร์ฟเวอร์ที่ถูกลบหรือสร้างไม่สำเร็จ

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

curl https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

ตัวอย่างการตอบกลับ

[
  {
    "id": "S-7K2M-9QX4-HB3T",
    "label": "web-1",
    "state": "running",
    "ipv4": "192.0.2.15",
    "ipv6": "2001:db8::15",
    "monthly": "2.48",
    "backups": false,
    "extra_disk_gb": 0,
    "ddos_protection": false,
    "paid_until": "2026-11-18T09:00:00.000Z"
  }
]

POST /servers

สร้างเซิร์ฟเวอร์และดำเนินการชำระเงิน ใช้รหัสจากแค็ตตาล็อกสำหรับแผนที่ตั้งและอิมเมจตามที่ระบุ label ใช้ตัวอักษรอังกฤษ ตัวเลข จุด และขีดได้ไม่เกิน 40 ตัว อักขระอื่นจะถูกแทนด้วยขีด backups, extra_disk_gb และ ddos_protection เป็นตัวเลือกเสริม เมื่อสำเร็จจะได้ 201 พร้อมข้อมูลเซิร์ฟเวอร์ และ root_password จะอยู่ในการตอบกลับนี้ครั้งเดียว (ดูได้ในหน้าเซิร์ฟเวอร์ของบัญชีเป็นเวลา 7 วันด้วย)

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

curl -X POST https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"plan":"s2","location":"frankfurt","image":"ubuntu-24-04","label":"web-1","backups":true,"extra_disk_gb":0,"ddos_protection":false}'

ตัวอย่างการตอบกลับ

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "creating",
  "ipv4": null,
  "ipv6": null,
  "monthly": "2.61",
  "backups": true,
  "extra_disk_gb": 0,
  "ddos_protection": false,
  "paid_until": "2026-11-18T09:00:00.000Z",
  "root_password": "..."
}

GET /servers/{id}

ส่งคืนสถานะ ที่อยู่ ค่าบริการรายเดือน และวันหมดอายุการชำระของเซิร์ฟเวอร์หนึ่งเครื่อง เซิร์ฟเวอร์ใหม่เริ่มที่ creating และเมื่อพร้อมจะเป็น running พร้อมเติม ipv4, ipv6 ตรวจสอบทุกไม่กี่วินาทีก็เพียงพอ

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

curl https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \
  -H "Authorization: Bearer YOUR_API_KEY"

ตัวอย่างการตอบกลับ

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "running",
  "ipv4": "192.0.2.15",
  "ipv6": "2001:db8::15",
  "monthly": "2.61",
  "backups": true,
  "extra_disk_gb": 0,
  "ddos_protection": false,
  "paid_until": "2026-11-18T09:00:00.000Z"
}

POST /servers/{id}/start (stop, reboot)

start เปิดเซิร์ฟเวอร์ที่หยุดอยู่ (stopped) ส่วน stop และ reboot ปิดหรือรีสตาร์ตเซิร์ฟเวอร์ที่กำลังทำงาน (running) การตอบกลับคือข้อมูลเซิร์ฟเวอร์ที่เปลี่ยนแล้ว

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

curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/reboot \
  -H "Authorization: Bearer YOUR_API_KEY"

ตัวอย่างการตอบกลับ

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "rebooting",
  ...
}

POST /servers/{id}/renew

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

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

curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/renew \
  -H "Authorization: Bearer YOUR_API_KEY"

ตัวอย่างการตอบกลับ

{
  "id": "S-7K2M-9QX4-HB3T",
  "state": "running",
  "paid_until": "2026-12-18T09:00:00.000Z",
  ...
}

DELETE /servers/{id}

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

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

curl -X DELETE https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \
  -H "Authorization: Bearer YOUR_API_KEY"

ตัวอย่างการตอบกลับ

{
  "id": "S-7K2M-9QX4-HB3T",
  "state": "deleted"
}

ฟิลด์ในการตอบกลับเซิร์ฟเวอร์

ค่าสถานะ

ข้อผิดพลาด

เมื่อเกิดข้อผิดพลาด จะได้ JSON รูปแบบ {"error": "รหัส"} พร้อมรหัสสถานะ แยกการจัดการตามค่ารหัสได้เลย

คู่มือที่ควรอ่านต่อ

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

ดูสิ่งที่ทำได้ด้วย API และตัวอย่างระบบอัตโนมัติได้ที่หน้า VPS API และดูค่าบริการรายเดือนตามสเปกได้ที่หน้าราคา