知识库

创建 API 令牌并发出第一个调用

作用域令牌、您第一天将使用的少数调用,以及在编写脚本之前值得了解的速率限制和错误格式。

创建范围最小的令牌

令牌在控制面板的账户下创建,并带有作用域:readwritebilling。具有write的令牌可以订购服务器,也就是说,泄露的令牌会花钱。给监控脚本read,仅此而已。

有两个设置值得使用:过期日期,以及将令牌固定到自动化运行所在前缀的源限制。两者都是可选的。两者都很便宜。

该值只显示一次,因为我们存储的是其哈希值,而不是令牌本身。丢失它意味着要创建一个新的。

export Paragon_TOKEN=...

比 shell 历史记录更好,在无人值守的机器上:

systemd-creds encrypt token.txt /etc/credstore.encrypted/paragon-token

第一次调用

curl -s https://paragonvps.com/api/v1/account -H "Authorization: Bearer $Paragon_TOKEN" | jq .

一切都是 JSON,一切都位于 /api/v1 下,每个响应都带有 request_id 标头。在工单中引用它,我们可以在几秒钟内找到确切调用,而不是询问您时间。

curl -s https://paragonvps.com/api/v1/instances -H "Authorization: Bearer $Paragon_TOKEN" | jq -r '.[] | .id + " " + .hostname + " " + .site + " " + .state'

订购一个

curl -s -X POST https://paragonvps.com/api/v1/instances -H "Authorization: Bearer $Paragon_TOKEN" -H "Content-Type: application/json" -H "Idempotency-Key: 2026-07-16-edge-01" -d '{"plan":"r-8","site":"AMS-01","image":"debian-13","hostname":"edge-01","ssh_keys":["primary"]}'

发送 Idempotency-Key 标头。在没有它的情况下重试 POST 会让人最终得到两台服务器和一个意图;该键会被记住二十四小时,并返回原始结果,而不是构建第二个实例。Cloud-init 用户数据放在同一正文中,base64 编码,放在 user_data_b64 下。

当余额覆盖第一个周期时,订单会从账户余额中扣除。否则,响应会附带发票和付款地址,实例在发票结算后出现。

速率限制和错误

每个令牌每分钟六百个请求。超过后,您会收到 429Retry-After 标头,这是供您读取的,而不是在循环中用固定休眠代替。

错误是 JSON,带有 code、人类可读的 messagerequest_id。状态给出类别:400 您发送的内容有误,401 令牌无效或被撤销,403 令牌缺少作用域,404 不存在或不属于您,409 实例处于无法执行该操作的状态,5xx 是我们的错误。

分页和轮询

集合接受 ?page=?per_page=,并返回 Link 标头。长时间操作会交给您一个作业,而不是阻塞,这涵盖了配置、迁移和恢复:

curl -s https://paragonvps.com/api/v1/jobs/<job-id> -H "Authorization: Bearer $Paragon_TOKEN" | jq -r .state

每隔几秒轮询一次,或者注册 webhook 并完全停止轮询。Webhook 已签名;在处理之前检查签名。

撤销

即时,从控制面板或使用另一个令牌:

curl -s -X DELETE https://paragonvps.com/api/v1/tokens/<token-id> -H "Authorization: Bearer $Paragon_TOKEN"

进行中的请求完成,下一个请求将收到 401。如果您怀疑令牌已泄露,请先撤销,然后再调查。令牌无法更改您的账户电子邮件或第二因素,但它肯定可以花钱。

完整参考、每个端点和每个字段,请参见 /docs/api

随时恭候

选择城市,选择大小,用加密货币支付。

无需填写关于您的身份信息的表格,无需等待人工审批,无需电话验证。账单结清后,凭证将发送到您的邮箱。