compute
POST /v1/compute/servers/{serverId}/snapshots
Take a snapshot of a server now.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung billing.payment.manage verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem 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> }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
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`.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
serverId (path) | Uuid | Ja | 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. |
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
description | string | Ja | 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. |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | string | Ja | The provider's identifier for the image. |
description | string | Ja | What the customer called it, or `""`. |
created_at | string | Ja | When it was taken, ISO-8601 as the provider states it, or `""`. |
size_gb | number | Ja | 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 | Ja | `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 | Ja | 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 | Ja | ISO-4217 code for `price_minor`, or `""` exactly when that is `null`. |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 422 · 429 · 503