โทเคนเดียว และทุกสิ่งที่แผงควบคุมทำได้

JSON ผ่าน HTTPS ไม่ต้องใช้ SDK ไม่ต้องมีบัญชีนักพัฒนาแยกต่างหาก และไม่มีเอนด์พอยต์ใดที่มีอยู่ในแผงควบคุมแต่ไม่มีที่นี่

สร้างเซิร์ฟเวอร์

curl -X POST https://api.vpsoffshore.com/v1/servers \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"plan":"reef","image":"debian-13"}'

ส่งคืนรหัส build ทันที เครื่องจะตอบสนองผ่าน SSH ประมาณ 60 วินาทีต่อมา และที่อยู่จะถูกกำหนดเส้นทางไว้ก่อนที่ข้อมูลรับรองจะถูกส่งออกไป

20 เอนด์พอยต์

ทุกอย่าง แบ่งเป็นห้ากลุ่ม

URL พื้นฐาน https://api.vpsoffshore.com/v1. กำหนดเวอร์ชันไว้ใน path โดย v1 จะยังใช้งานได้ต่อไปแม้ v2 เปิดให้บริการแล้ว และวันที่จะหยุดรองรับจะประกาศล่วงหน้า 1 ปี

เซิร์ฟเวอร์

GET /servers ทุกบริการในบัญชี พร้อมสถานะ แพ็กเกจ และที่อยู่

POST /servers สร้างหนึ่งเครื่อง ระบบตอบกลับทันทีพร้อม build id เซิร์ฟเวอร์จะเข้าถึงได้ภายในประมาณหนึ่งนาทีถัดมา

GET /servers/{id} 1 บริการ รวมถึงการใช้ทรัพยากรแบบสดในชั่วโมงที่ผ่านมา

PATCH /servers/{id} เปลี่ยนแพ็กเกจ ปรับขนาดได้โดยไม่ต้องติดตั้งใหม่หากดิสก์รองรับ

DELETE /servers/{id} ทำลายเครื่อง ดิสก์จะถูกเก็บไว้ 14 วัน ก่อนถูกล้างข้อมูลแล้วนำกลับมาใช้ใหม่

POST /servers/{id}/actions reboot · shutdown · start · rebuild · rescue · reset-password.

พื้นที่จัดเก็บ

GET /servers/{id}/snapshots สแนปช็อตของบริการหนึ่งรายการ เรียงจากล่าสุดไปเก่าสุด

POST /servers/{id}/snapshots สร้างสแนปช็อตหนึ่งชุด แบบ thin จึงรวดเร็วและไม่เพิ่มพื้นที่ดิสก์เป็นสองเท่า

POST /snapshots/{id}/restore กู้คืนในตำแหน่งเดิม หรือไปยังบริการอื่นที่เป็นแพ็กเกจเดียวกันหรือใหญ่กว่า

DELETE /snapshots/{id} ลบสแนปช็อต

ระบบเครือข่าย

GET /servers/{id}/addresses ที่อยู่ที่กำหนดเส้นทางแล้วไปยังบริการ ทั้ง v4 และ v6

POST /servers/{id}/addresses ขอที่อยู่เพิ่มเติม หรือขอ /29

PUT /addresses/{ip}/rdns ตั้งค่า reverse DNS มีผลภายในหนึ่งนาที ไม่ต้องรอรอบรีเฟรชโซนถัดไป

GET /servers/{id}/bandwidth ตัวนับการโอนข้อมูล ใช้เพื่อข้อมูลเท่านั้น — ไม่มีโควตาที่ต้องกังวลว่าจะเกิน

แคตตาล็อก

GET /plans ทุกแพ็กเกจพร้อมข้อกำหนดและราคา จากแหล่งข้อมูลเดียวกับที่เว็บไซต์นี้ใช้แสดงผล

GET /images อิมเมจและ ISO ที่พร้อมใช้งาน รวมถึงไฟล์ที่คุณอัปโหลดเอง

POST /images อัปโหลด ISO ผ่าน URL บูตพร้อมคอนโซลที่เชื่อมต่ออยู่

การเรียกเก็บเงิน

GET /invoices ใบแจ้งหนี้ ทั้งที่ชำระแล้วและค้างชำระ พร้อมเหรียญและธุรกรรมบนบล็อกเชน

POST /invoices/{id}/pay ออกที่อยู่การชำระเงินสำหรับหนึ่งใน 8 เหรียญที่รองรับ

GET /credits เครดิตชดเชยตาม SLA ที่มอบให้ พร้อมเหตุการณ์ที่ก่อให้เกิดเครดิตแต่ละรายการ

ทุกสิ่งที่แผงควบคุมทำได้ มีอยู่ที่นี่ และไม่มีสิ่งใดที่นี่ที่ขาดหายไปจากแผงควบคุม หากทั้งสองไม่ตรงกัน นั่นคือข้อบกพร่อง — แจ้งเราจากแผงควบคุม แล้วเราจะแก้ไข ไม่ใช่บันทึกไว้ว่าเป็นพฤติกรรมที่ตั้งใจ

ลักษณะการทำงาน

สี่การตัดสินใจที่คุณจะสังเกตได้ภายในหนึ่งชั่วโมง

API ถูกตัดสินจากเส้นทางที่ผิดพลาด ไม่ใช่เส้นทางที่ถูกต้อง สามในสี่ข้อด้านล่างนี้เกี่ยวกับสิ่งที่เกิดขึ้นเมื่อมีบางอย่างผิดพลาด

โทเคนเดียว สร้างได้จากแผงควบคุม

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

รับเข้าเป็น JSON ส่งออกเป็น JSON ไม่จำเป็นต้องใช้ SDK

HTTPS ธรรมดา ไม่มี envelope กำหนดเอง ไม่มี XML สำรอง และไม่มีพิธีกรรมการลงนามใด ๆ หาก curl ทำได้ ก็ถือว่ามีไคลเอนต์แล้ว มีไลบรารีทางการสำหรับ Go, Python และ TypeScript แต่ไม่มีตัวใดจำเป็นต้องใช้

ขีดจำกัดอัตราการใช้งานที่คุณจะไม่ชนโดยบังเอิญ

600 คำขอต่อนาทีต่อหนึ่งโทเคน ส่วนคำขอสร้างรายการจำกัดที่ 60 คำขอ การตอบกลับทุกครั้งแจ้งโควตาที่เหลือไว้ในส่วนหัว เมื่อเกินขีดจำกัดจะได้รับรหัส 429 พร้อมจำนวนวินาทีที่ต้องรอ ไม่ใช่การทิ้งคำขอแบบไม่แจ้งเตือน

ข้อความแสดงข้อผิดพลาดที่บอกวิธีแก้ไข

4xx มาพร้อมรหัสที่เครื่องอ่านได้ ประโยคที่มนุษย์อ่านเข้าใจ และช่องข้อมูลที่ผิดพลาด เราขอส่งข้อความแสดงข้อผิดพลาดที่ยาวดีกว่าข้อความสั้น ๆ ที่ต้องเดาเอาเอง

สองสิ่งที่คุณเขียนเพียงครั้งเดียว

การยืนยันตัวตน และลักษณะของข้อผิดพลาด

ทั้งสองฉบับควรอ่านก่อนเขียนคำสั่งเรียกแรก ไม่ใช่หลังจากความล้มเหลวครั้งแรก

ยืนยันตัวตน

curl https://api.vpsoffshore.com/v1/servers \
  -H "Authorization: Bearer $TOKEN"

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

อ่านเรื่องการจำกัดอัตรา

X-RateLimit-Remaining: 574
X-RateLimit-Reset: 41

บนทุกการตอบกลับ ไม่ใช่แค่ครั้งที่ล้มเหลว การเกินขีดจำกัดจะคืนค่า 429 พร้อมจำนวนวินาทีที่ต้องรอ ไม่มีการดร็อปคำขอแบบเงียบๆ และไม่มีการตอบกลับแบบตัดทอน

ข้อผิดพลาดจะระบุฟิลด์ให้คุณทราบ

{"error":"plan_unknown",
 "message":"No plan named 'reff'. Did you mean 'reef'?",
 "field":"plan"}

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

ตรวจสอบสถานะการสร้างเครื่อง

curl https://api.vpsoffshore.com/v1/servers/$ID \
  -H "Authorization: Bearer $TOKEN" | jq .state

building → running ไม่มี webhook ที่ต้องลงทะเบียนก่อนจึงจะสร้างสิ่งใดได้ และ polling ทุกหนึ่งวินาทีก็อยู่ในขีดจำกัดที่อนุญาต

ไม่มีอะไรต้องยื่นขอ

โทเคนอยู่ในแผงควบคุมลูกค้า และแผงควบคุมลูกค้ามาพร้อมกับเซิร์ฟเวอร์เครื่องแรก

ไม่ต้องมีบัญชีนักพัฒนา ไม่ต้องขออนุมัติ ไม่มีแซนด์บ็อกซ์ที่ทำงานต่างไปจากระบบจริง

เริ่มต้นด้วยเซิร์ฟเวอร์เดียว ดัชนีเอกสาร

อ่านต่อไป

ไปต่อจากตรงนี้