VPS.org API

REST API 文件

备份 API

列出您的服务器备份, 开始新的备份, 并从服务器上恢复服务器 。

终点 4
基本路径 /api/v1/backups
得到 /api/v1/backups/

列出所有备份

返回所有服务器的备份, 最新的是第一个, 每页25。 没有服务器过滤器: 使用服务器_ 主机名来分组 。

所需许可: backups:list

查询参数

参数 类型 必需的 说明
page integer 否 无 页码,从1开始

示例请求

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for backup in response.json()["results"]:
    print(backup["id"], backup["server_hostname"], backup["created_at"])
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

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

示例回复

{
  "count": 96,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [
    {
      "id": 5512,
      "server_hostname": "web-01",
      "name": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
      "size_gb": 3.12,
      "deletion_date": "2026-09-21T20:45:40.697512Z",
      "days_remaining": 6,
      "created_at": "2026-09-14T20:45:40.699494Z"
    }
  ]
}

响应字段

外地 类型 说明
id integer 获取和恢复终点时使用的备份标识符
server_hostname string 服务器主机名 备份是从
name string 备份归档文件名
size_gb number 以千兆字节压缩的大小
deletion_date datetime 何时自动删除备份
days_remaining integer 删除日期前剩下的整天
created_at datetime 创建时间(ISO 8601,世界协调时)

响应状态码

200 成功获取备份列表
403 遗失或无效 API 牌标牌, 或者该牌牌缺少必需的许可
得到 /api/v1/backups/{id}/

获取备份

返回上面字段的备份对象。

curl -X GET "https://admin.vps.org/api/v1/backups/5512/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
邮 /api/v1/servers/{uuid}/backup/

创建备份

将配置服务器的备份排成队列。 不需要请求机构。 备份一旦完成, 就会出现在列表中, 视磁盘使用情况而定, 需要几分钟时间 。

所需许可: servers:backup

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/backup/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/backup/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

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

示例回复

{
  "message": "Backup queued successfully"
}

响应状态码

200 动作被排队
400 服务器尚未安装
402 档案中没有付款方法或未付发票
404 未找到, 或属于另一个账户
邮 /api/v1/backups/{id}/restore/

从备份中恢复服务器

停止备份从服务器上取出备份, 以备份覆盖磁盘并重新启动。 不需要请求 body 。 服务器状态在恢复运行时排队 。

所需许可: backups:restore

curl -X POST "https://admin.vps.org/api/v1/backups/5512/restore/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Backup restore queued. The server will be stopped, restored, and restarted.",
  "backup": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
  "job_id": "b6f1c7e2-3a4d-4f5e-8b9c-0d1e2f3a4b5c"
}
警告: 备份丢失后所有写入服务器的文字都丢失。 无法撤销恢复 。

响应状态码

200 动作被排队
400 服务器尚未安装
404 未找到, 或属于另一个账户

注注注音音小小小