เอกสาร API VPS.org

เริ่มต้นใช้งาน

API ของ VPS.org ช่วยให้คุณสามารถจัดการโครงสร้างพื้นฐานการโฮสติ้ง VPS ทั้งหมดได้โดยใช้โปรแกรม รวมถึงเซิร์ฟเวอร์ โดเมน บันทึก DNS การสำรองข้อมูล และสแนปช็อต

การตรวจสอบสิทธิ์

การร้องขอผ่าน API ทุกครั้งจำเป็นต้องมีการตรวจสอบสิทธิ์โดยใช้โทเค็น Bearer คุณสามารถสร้างโทเค็น API ได้จากการตั้งค่าบัญชีของคุณที่ admin.vps.org/account/developers/.

curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

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

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

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

ทุกโทเค็นจะมีสิทธิ์ในการใช้งานของตัวเอง เช่น servers: list หรือ dns: * การร้องขอที่ต้องการสิทธิ์ในการใช้งานที่โทเค็นไม่สามารถให้ได้ จะถูกปฏิเสธด้วยค่า 403 และช่อง required_ permission ที่ระบุสิทธิ์ที่ขาดหายไป คำอ้างสิทธิ์

การจำกัดอัตรา

การร้องขอที่ผ่านการตรวจสอบสิทธิ์จะถูกจำกัดไว้ที่ 1,000 ครั้งต่อชั่วโมงต่อบัญชีผู้ใช้ และการร้องขอที่ไม่ผ่านการตรวจสอบสิทธิ์จะถูกจำกัดไว้ที่ 100 ครั้งต่อชั่วโมงต่อที่อยู่ IP หากมีการร้องขอที่เกินกว่าจำนวนนี้ จะได้รับค่า 429 พร้อมกับหัวข้อ Retry- After ซึ่งจะแสดงจำนวนวินาทีที่ต้องรอ ไม่มีหัวข้อจำกัดอัตราการส่งข้อมูลจะถูกส่งเมื่อมีการตอบสนองที่สำเร็จ

ปรับแต่งหน้า

จุดจบของรายการจะคืนผลลัพธ์เป็นรายการที่มีจำนวน, ถัดไป, ก่อนหน้า และผลลัพธ์, 25 รายการต่อหน้า ใช้การสลับหน้าเพื่อย้ายระหว่างหน้า หรือใช้ URL ถัดไปจนกว่าจะไม่มีค่า รายการเซิร์ฟเวอร์ยังรองรับ page_ size สูงสุดถึง 100 ตัว

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

การจัดการข้อผิดพลาด

API นี้ใช้รหัสสถานะ HTTP มาตรฐานเพื่อระบุความสำเร็จหรือความล้มเหลว:

ส่วนประกอบของข้อผิดพลาดเป็น JSON ส่วนใหญ่จะมีช่องรายละเอียดหรือช่องข้อผิดพลาด บางครั้งก็มีข้อความ ข้อผิดพลาดในการตรวจสอบจะแสดงปัญหาตามชื่อช่อง

หมวดหมู่ API

เรียกดูเอกสารประกอบ API ของเราตามหมวดหมู่:

เพิ่มจุดสิ้นสุด

API ยังมีจุดสิ้นสุดสำหรับการติดตั้งแอพพลิเคชัน (/ api/ v1/ deploy- configs / และ / api/ v1/ deployments /) ยังไม่มีคำอธิบายของมันในหน้านี้; คำอธิบายแบบแสดงผลแสดงรายการจุดสิ้นสุดทุกจุดที่สร้างจาก API แบบสด

ต้องการความช่วยเหลือ?

หากคุณมีคำถามหรือต้องการความช่วยเหลือเกี่ยวกับ API โปรดอย่าลังเลที่จะติดต่อเรา:

• ระบบแจ้งปัญหา: เปิดตั๋วขอความช่วยเหลือ
• อีเมล: hello@vps.org
• เอกสาร: เอกสารฉบับเต็ม