VPS.org API

REST API 文件

快照 API

获取服务器贴有标签的快照, 列出并删除不再需要的快照 。

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

列出所有快照

返回您账户中的最新快照, 最新的第一位, 每页25个。

所需许可: snapshots:list

示例请求

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

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

response = requests.get(url, headers=headers)
for snapshot in response.json()["results"]:
    print(snapshot["uuid"], snapshot["label"], snapshot["ready"])
const response = await fetch('https://admin.vps.org/api/v1/snapshots/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

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

示例回复

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b",
      "label": "before-upgrade",
      "server_hostname": "web-01",
      "ready": true,
      "deleting": false,
      "created_at": "2026-09-14T18:30:00.000000Z",
      "size_gb": 3.4
    }
  ]
}

响应字段

外地 类型 说明
uuid string 抓图识别符( 32 个十六进制字符, 没有连字符)
label string 创建快照时给出标签
server_hostname string 服务器主机名 : 抓抓快照是从服务器取出的主机名, 如果服务器已不存在, 则无效
ready boolean 照片一拍完,就是真的
deleting boolean 正在删除时正确
created_at datetime 创建时间(ISO 8601,世界协调时)
size_gb number 以千兆字节压缩的大小
得到 /api/v1/snapshots/{uuid}/

获得快照

返回上面字段的一个快照对象。 创建快照后, 使用它进行民意调查 。

curl -X GET "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
邮 /api/v1/servers/{uuid}/snapshot/

创建抓图

将一个已部署服务器的快照排成一个快照, 并返回新快照的 uid。 快照将直接列出, 并准备假的 。

所需许可: servers:snapshot

请求体参数

参数 类型 必需的 说明
action string 是的 一定要快快
snapshot_label string 是的 用于识别快照的标签
cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/snapshot/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action": "snapshot", "snapshot_label": "before-upgrade"}'
import requests

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

response = requests.post(url, headers=headers, json=data)
print(response.json()["snapshot_uuid"])

示例回复

{
  "message": "Snapshot queued successfully",
  "snapshot_uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b"
}

响应状态码

200 动作被排队
400 服务器尚未部署
402 档案中没有付款方法或未付发票
404 未找到, 或属于另一个账户
删除 /api/v1/snapshots/{uuid}/

删除抓图

将永久删除的快照排成队列。删除在它消失之前是真实的。

所需许可: snapshots:delete

curl -X DELETE "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Snapshot deletion queued"
}

响应状态码

202 接受:请求被排队
404 未找到, 或属于另一个账户

注注注音音小小小