compute
POST /v1/compute/servers/{serverId}/backups
Turn a server's automatic backups on or off.
認証
ベアラー トークンとして API キーを送信します。キーには billing.payment.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/backups \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "enabled": <boolean> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
⛔⛔ Chargeable one way and destructive the other. Enabling costs a percentage of the machine's price for as long as it runs — a recurring change to what the customer pays. Disabling deletes the restore points that already exist, at the provider, with no undo anywhere. Both belong behind a confirmation that says which one is happening. The response is the arrangement re-read from the provider, never an echo of the request: an asynchronous write followed by an immediate synchronous read has been measured on a real machine reporting "saved" over the old value. 503 on a range whose provider exposes no verb for this — that is a permanent property of the range, not a temporary failure, and a client should render the statement rather than invite a retry. Requires billing.payment.manage.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
serverId (path) | Uuid | はい | 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. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
enabled | boolean | はい | Whether automatic backups should run. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
enabled | boolean | はい | Whether the provider takes automatic backups of this machine. |
manageable | boolean | はい | Whether we can change that through an API. false means the customer has a real backup arrangement we can describe and cannot alter — render a statement, not a switch. |
tier | string | はい | The provider's own name for the tier, verbatim and untranslated, or "". ⛔ Never round it to a boolean: "which tier am I on" and "are backups on" are different questions, and an… |
window | string | はい | The daily window backups are taken in, as stated ("22-02"), or "". |
retained | integer | はい | How many restore points are kept. null when unknown — never 0 as a guess, because "we keep none" is a different promise. |
price_minor | integer | はい | What we charge per month to keep this on, in integer minor units of price_currency. ⛔⛔ null means we cannot state a price for this machine — the truth on the resold… |
price_currency | string | はい | ISO-4217 code for price_minor, or "" exactly when that is null. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503