hosting
POST /v1/sites/{siteId}/website-backups
Take a standard backup of a site's files and databases.
認証
ベアラー トークンとして API キーを送信します。キーには hosting.backup.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/website-backups \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Asks the hosting platform to build a fresh archive of this site's files and databases. `202`, because the platform runs the job afterwards and a `200` would claim an instant we never observed. ⛔ **The response is the new state of the surface, never a bare acknowledgement** — the client writes it straight into its cache, so an empty body would leave the button un-flipped and the poll never started. There is deliberately **no restore verb** on this resource: the platform restores this product from an archive the customer uploads by hand, so a Restore control here could only ever fail. `404` for a site with no vendor hosting package, or one that is not the caller's. Requires `hosting.backup.manage`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
available | boolean | はい | Whether this site runs on a hosting package with a standard-backup surface at all. `false` renders nothing rather than an empty list. |
retention_hours | integer | はい | How long the platform keeps one. Sent rather than hardcoded in the client so the screen can show a real expiry, and so it cannot drift if the platform changes it. |
backup | WebsiteBackup | はい | The current backup, or `null` when the platform holds none. ⛔ `null` never means we failed to ask — that is an error status, not an empty surface. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503