compute

POST /v1/compute/servers/{serverId}/snapshots

Take a snapshot of a server now.

Alle compute-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie billing.payment.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw 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> }'

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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

NaamTypeVerplichtWat dit is
serverId (path)UuidJaThe 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.

Aanvraaglichaam

NaamTypeVerplichtWat dit is
descriptionstringJaWhat 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.

Reactie

NaamTypeVerplichtWat dit is
idstringJaThe provider's identifier for the image.
descriptionstringJaWhat the customer called it, or `""`.
created_atstringJaWhen it was taken, ISO-8601 as the provider states it, or `""`.
size_gbnumberJaBillable 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…
readybooleanJa`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_minorintegerJaWhat **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_currencystringJaISO-4217 code for `price_minor`, or `""` exactly when that is `null`.

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422 · 429 · 503