compute
POST /v1/compute/servers/{serverId}/snapshots
Take a snapshot of a server now.
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}/snapshots \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "description": <string> }'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
Images the machine's disk as it is right now, so the customer has a point to come back to before an upgrade or a risky change. ⛔ **It bills for storage until it is deleted.** It is not destructive — snapshotting a running machine changes nothing about it — but it is a recurring cost, so it is gated on the spend key rather than on the operate key. The snapshot comes back with `ready: false`: imaging a disk takes minutes and the request is not held for it. Poll the listing; a restore must not be offered until `ready` is true. 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 |
|---|---|---|---|
description | string | Yes | What to call it. Required and non-blank: an unnamed snapshot renders as a bare provider id, and a list of bare ids is one a customer cannot choose a restore point from. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | The provider's identifier for the image. |
description | string | Yes | What the customer called it, or `""`. |
created_at | string | Yes | When it was taken, ISO-8601 as the provider states it, or `""`. |
size_gb | number | Yes | Billable size. `null` while the provider is still measuring it — which it is for the first seconds after creation. ⛔ "Not measured yet" and "takes no space" are different claims… |
ready | boolean | Yes | `false` while the provider is still writing it. ⛔ A restore offered on an unfinished snapshot restores an incomplete disk, and the provider will start it. |
price_minor | integer | Yes | What **we** charge per month to keep this snapshot, in integer minor units of `price_currency`. ⛔ `null` exactly while `size_gb` is `null`: the provider has not finished measuri… |
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