compute

GET /v1/compute/servers/{serverId}/backups

A server's automatic backup arrangement.

All compute endpoints

Authentication

Send an API key as a bearer token. The key must carry the sites.view 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 GET https://api.zinndigital.com/v1/compute/servers/{serverId}/backups \
  -H "Authorization: Bearer zdk_live_…"

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

Whether the provider is backing this machine up, which tier it is on, when backups run and how many are kept. ⛔⛔ **Read `manageable` before rendering a control.** The two ranges differ: on the resold range the tier is readable and there is no verb to change it, so the honest surface is a statement and an upgrade route; on our own cloud it is a switch. A client that assumed it could always write would show half the estate a toggle that fails. Requires `sites.view`.

Parameters

NameTypeRequiredWhat it is
serverId (path)UuidYesThe 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.

Response

NameTypeRequiredWhat it is
enabledbooleanYesWhether the provider takes automatic backups of this machine.
manageablebooleanYesWhether **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.
tierstringYesThe 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…
windowstringYesThe daily window backups are taken in, as stated (`"22-02"`), or `""`.
retainedintegerYesHow many restore points are kept. `null` when unknown — never `0` as a guess, because "we keep none" is a different promise.
price_minorintegerYesWhat **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_currencystringYesISO-4217 code for `price_minor`, or `""` exactly when that is `null`.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429 · 503