Tài liệu API VPS.org

Bắt đầu

API của VPS.org cho phép bạn quản lý theo lập trình tất cả các khía cạnh của cơ sở hạ tầng lưu trữ VPS của mình, bao gồm máy chủ, tên miền, bản ghi DNS, sao lưu và ảnh chụp nhanh.

Xác thực

Tất cả các yêu cầu API đều yêu cầu xác thực bằng mã thông báo Bearer. Bạn có thể tạo mã thông báo API của mình từ cài đặt tài khoản tại đây. 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);

Mỗi token mang quyền riêng của nó, như servers:list hoặc dns:*. Một yêu cầu cần một quyền mà token không có sẽ bị từ chối với 403 và một trường required_permission đặt tên cho quyền thiếu. Truy cập quyền

Giới hạn tốc độ

Các yêu cầu xác thực được giới hạn là 1000 mỗi giờ cho mỗi tài khoản. Các yêu cầu không xác thực được giới hạn là 100 mỗi giờ cho mỗi địa chỉ IP. Một yêu cầu vượt quá giới hạn sẽ nhận được 429 với đầu Retry- After cho biết số giây chờ. Không có đầu giới hạn tốc độ nào được gửi khi đáp ứng thành công.

Đánh dấu trang

Điểm kết thúc danh sách trả về một đối tượng với số, tiếp theo, trước và kết quả, 25 mục trên mỗi trang. Đưa trang để di chuyển giữa các trang, hoặc theo URL tiếp theo cho đến khi nó rỗng. Danh sách máy chủ cũng chấp nhận page_ size, lên đến 100.

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

Xử lý lỗi

API sử dụng các mã trạng thái HTTP tiêu chuẩn để cho biết trạng thái thành công hay thất bại:

Thân lỗi là JSON. Hầu hết có một trường chi tiết hoặc một trường lỗi, đôi khi với một thông điệp; lỗi xác minh liệt kê các vấn đề theo tên trường.

Danh mục API

Xem tài liệu API của chúng tôi theo từng danh mục:

Nhiều điểm cuối hơn

API cũng có điểm cuối cho việc triển khai ứng dụng (/api/v1/deploy-configs/ và /api/v1/deployments/). Chúng chưa được mô tả trên các trang này; tham chiếu tương tác liệt kê mỗi điểm cuối, được tạo ra từ API sống.

Cần trợ giúp?

Nếu bạn có thắc mắc hoặc cần hỗ trợ về API, vui lòng liên hệ với chúng tôi:

• Phiếu yêu cầu hỗ trợ: Mở yêu cầu hỗ trợ
• E-mail: hello@vps.org
• Tài liệu: Tài liệu đầy đủ