compute

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

Take a snapshot of a server now.

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation billing.payment.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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> }'

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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`.

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`serverId (path)`	`Uuid`	Oui	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.

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`description`	`string`	Oui	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.

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`id`	`string`	Oui	The provider's identifier for the image.
`description`	`string`	Oui	What the customer called it, or `""`.
`created_at`	`string`	Oui	When it was taken, ISO-8601 as the provider states it, or `""`.
`size_gb`	`number`	Oui	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`	Oui	`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`	Oui	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`	Oui	ISO-4217 code for `price_minor`, or `""` exactly when that is `null`.

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422 · 429 · 503

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