compute
POST /v1/compute/servers/{serverId}/backups
Turn a server's automatic backups on or off.
Authentication
Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/backups \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "enabled": <boolean> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
⛔⛔ **Chargeable one way and destructive the other.** Enabling costs a percentage of the machine's price for as long as it runs — a recurring change to what the customer pays. Disabling **deletes the restore points that already exist**, at the provider, with no undo anywhere. Both belong behind a confirmation that says which one is happening. The response is the arrangement **re-read from the provider**, never an echo of the request: an asynchronous write followed by an immediate synchronous read has been measured on a real machine reporting "saved" over the old value. `503` on a range whose provider exposes no verb for this — that is a permanent property of the range, not a temporary failure, and a client should render the statement rather than invite a retry. Requires `billing.payment.manage`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
serverId (path) | Uuid | Yes | The 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. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
enabled | boolean | Yes | Whether automatic backups should run. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
enabled | boolean | Yes | Whether the provider takes automatic backups of this machine. |
manageable | boolean | Yes | Whether **we** can change that through an API. `false` means the customer has a real backup arrangement we can describe and cannot alter — render a statement, not a switch. |
tier | string | Yes | The provider's own name for the tier, verbatim and untranslated, or `""`. ⛔ Never round it to a boolean: "which tier am I on" and "are backups on" are different questions, and a… |
window | string | Yes | The daily window backups are taken in, as stated (`"22-02"`), or `""`. |
retained | integer | Yes | How many restore points are kept. `null` when unknown — never `0` as a guess, because "we keep none" is a different promise. |
price_minor | integer | Yes | What **we** charge per month to keep this on, in integer minor units of `price_currency`. ⛔⛔ `null` means *we cannot state a price for this machine* — the truth on the resold ra… |
price_currency | string | Yes | ISO-4217 code for `price_minor`, or `""` exactly when that is `null`. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503