Tài liệu API của VPS.org

Tài liệu API REST đầy đủ để quản lý máy chủ VPS, tên miền, DNS, sao lưu và nhiều hơn nữa.

URL cơ sở https://admin.vps.org/api/v1

Xác thực Mã thông báo người mang

Phiên bản v1.0

Định dạng JSON

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

Python

JavaScript

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);

Giới hạn tốc độ

Mỗi mã thông báo API chỉ được phép gửi tối đa 300 yêu cầu trong vòng 5 phút . Thông tin về giới hạn số lượng yêu cầu được bao gồm trong tiêu đề phản hồi:

X-RateLimit-Limit: Số lượng yêu cầu tối đa được cho phép
X-RateLimit-Remaining: Số lượng yêu cầu còn lại
X-RateLimit-Reset: Thời điểm đặt lại giới hạn tốc độ

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:

Mã trạng thái	Sự miêu tả
`200`	Thành công - Yêu cầu đã được hoàn thành thành công
`201`	Đã tạo - Tài nguyên đã được tạo thành công
`400`	Yêu cầu không hợp lệ - Tham số không hợp lệ hoặc yêu cầu không đúng định dạng
`401`	Không được phép - Mã xác thực không hợp lệ hoặc bị thiếu.
`403`	Bị cấm - Không đủ quyền
`404`	Không tìm thấy - Tài nguyên không tồn tại
`429`	Quá nhiều yêu cầu - Đã vượt quá giới hạn số lượng yêu cầu
`500`	Lỗi máy chủ nội bộ - Đã xảy ra sự cố ở phía chúng tôi.

Danh mục API

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

API máy chủ 9 điểm cuối

Tạo, quản lý và điều khiển máy chủ VPS. Bao gồm quản lý nguồn điện, thay đổi kích thước, cài đặt lại và truy xuất thông tin máy chủ.

Xem tài liệu

API sao lưu 3 điểm cuối

Quản lý các bản sao lưu tự động và thủ công cho máy chủ của bạn. Liệt kê, tạo, khôi phục và xóa các bản sao lưu máy chủ.

Xem tài liệu

API ảnh chụp nhanh 4 điểm cuối

Tạo và quản lý ảnh chụp nhanh máy chủ để khôi phục dữ liệu nhanh chóng. Hoàn hảo cho việc thử nghiệm và khôi phục lại trạng thái trước đó nhanh chóng.

Xem tài liệu