compute

POST /v1/compute/servers/{serverId}/add-on

Buy an add-on for this machine.

所有 compute 端点

所有开发者文档

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/add-on \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "code": <string> }'

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

Requires sites.view and billing.payment.manage. ⛔⛔ It was billing.entitlement.manage until 2026-08-17, which no customer role holds, so the add-on designed to be turned on later could be turned on by nobody who owns a machine. The gate moved because the property behind it did: the add-on's price now joins the machine's subscription (priced into the cart line at order, moved from the next period when taken later), so this no longer spends Zinn®'s money and bills nobody. ⚖️ billing.payment.manage is the key the owner ruled for this class of control on 2026-08-17 (docs/136 §2e) — owner and billing, and deliberately not dev: a developer creates sites, and does not commit the organisation to a recurring licence. ⛔ A machine with no subscription is refused 422 unless the caller also holds billing.entitlement.manage. Nothing would charge for the add-on there — that is the staff "on the house" path, and it stays deliberate rather than accidental. ⛔⛤ AN ADD-ON WITH applies_at OF running OR running_reboot IS INSTALLED ON THE MACHINE AS IT STANDS, AND THE DATA ON IT IS NOT TOUCHED. Until 2026-08-31 this endpoint refused every one of them with a sentence about rebuilding the disk. That sentence described a limitation of cloud-init, which runs only at create, and not of Plesk or CloudLinux — both of which ship installers whose documented purpose is converting a server that is already running. docs/314 carries the vendor evidence. Such a request starts a Temporal workflow and answers 201 with state of installing (or queued, when a pooled licence is out of stock). The client polls GET for install_step. Plesk takes around fifteen minutes; CloudLinux restarts the machine once. ⛔⛔ It requires access — one-time root credentials — and it is refused 422 without them. This range hands SSH keys to the customer at build and the platform holds no key to any machine on it, so there is no standing credential to reach a running box with, and docs/127 D4 chose deliberately never to create one. The credential is written to Vault under a path scoped to this one assignment, read only inside the install activities, kept out of the workflow history, and deleted on every terminal outcome — success, failure or refusal. ⛔ A genuinely build-only add-on is still refused 422 with a sentence naming the remedy. Nothing in the catalogue is build-only today; the refusal is kept for the day something is. ⛔ 503, not 422, when a pooled licence is out of stock at order time: the customer's next action is to try again, not to change their order. ⚖️ On a machine that is already running the same condition queues instead, by the owner's ruling of 2026-08-31 — the two paths differ because the moment differs, and at order time a refusal still reaches the customer before they have committed.

参数

名称类型必填内容简介
serverId (path)UuidThe server's id, as listComputeServers reports it. Ours (UUIDv7), minted when the order row was written — never the provider's own identifier for the machine.

请求正文

名称类型必填内容简介
codestringThe add-on's catalogue code. bare records nothing.
currencystringThe currency to charge in. ⛔ Frozen onto the assignment at purchase, so a later admin repricing does not move an existing customer's bill.
accessobjectOne-time root access to the machine, required for any add-on whose applies_at is running or running_reboot and ignored for the rest. ⛔⛔…

响应

名称类型必填内容简介
dataobject

此端点可能返回的错误

401 · 403 · 404 · 422 · 429 · 503