VPS.org API

REST API 文档

VPS.org API 文档

完整的 REST API 文档,用于管理 VPS 服务器、域名、DNS、备份等。

基本 URL https://admin.vps.org/api/v1
验证 持有者代币
版本 v1.0
格式 JSON

入门

VPS.org API 允许您以编程方式管理 VPS 主机基础设施的各个方面,包括服务器、域名、DNS 记录、备份和快照。

验证

所有 API 请求都需要使用 Bearer 令牌进行身份验证。您可以在帐户设置中生成 API 令牌。 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);

速率限制

每个 API 令牌每 5 分钟最多只能发出 300 次 API 请求。速率限制信息包含在响应头中:

错误处理

API 使用标准的 HTTP 状态码来指示成功或失败:

状态码 描述
200 成功 - 请求已成功完成
201 资源已成功创建
400 错误请求 - 无效参数或格式错误的请求
401 未授权 - 身份验证令牌无效或缺失
403 禁止访问 - 权限不足
404 未找到 - 资源不存在
429 请求过多 - 超出速率限制
500 内部服务器错误 - 我们这边出了点问题

API 类别

按类别浏览我们的 API 文档:

服务器 API 9个端点

创建、管理和控制VPS服务器。包括电源管理、调整大小、重新安装和服务器信息检索。

查看文档
备份 API 3个端点

管理服务器的自动和手动备份。列出、创建、恢复和删除服务器备份。

查看文档
快照 API 4 个端点

创建和管理服务器快照,以便快速恢复。非常适合测试和快速回滚。

查看文档
计划 API 2 个端点

获取可用的VPS方案和定价信息。了解资源、定价和可用性等详细信息。

查看文档
操作系统 API 2 个端点

列出可用于服务器部署的操作系统和镜像。包括 Ubuntu、Debian、CentOS 等。

查看文档
域 API 6 个端点

搜索、查询可用性、注册和管理域名。通过 API 完成域名生命周期管理。

查看文档
DNS API 4 个端点

以编程方式管理 DNS 区域和记录。创建、更新和删除 A、AAAA、CNAME、MX、TXT 和其他记录类型。

查看文档
位置 API 1 端点

列出可用于服务器部署的数据中心位置。您可以从全球多个区域中选择。

查看文档

需要帮助吗?

如果您对 API 有任何疑问或需要帮助,请随时联系我们: