compute

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

Take a snapshot of a server now.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão billing.payment.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

Nome	Tipo	Obrigatório	O que é
`serverId (path)`	`Uuid`	Sim	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.

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`description`	`string`	Sim	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.

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`string`	Sim	The provider's identifier for the image.
`description`	`string`	Sim	What the customer called it, or `""`.
`created_at`	`string`	Sim	When it was taken, ISO-8601 as the provider states it, or `""`.
`size_gb`	`number`	Sim	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`	Sim	`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`	Sim	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`	Sim	ISO-4217 code for `price_minor`, or `""` exactly when that is `null`.

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429 · 503

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