hosting

GET /v1/sites/{siteId}/website-backups

The standard backup a site's hosting package currently holds.

すべての hosting エンドポイント

認証

ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/website-backups \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

The hosting platform's **included** on-demand backup for this site — a downloadable archive of files and databases. This is a different product from `getSiteVendorSnapshots`, which is the platform's *paid* point-in-time service, and from `listSiteBackups`, which is our own archive. ⛔ **The platform deletes one of these after `retention_hours`** (12 today). That is the character of the product: it is a button, not a history, and a client must render the real age rather than presenting it as durable protection. `backup` is `null` when the platform holds none — never when we failed to ask, which is an error status. ⭐ `complete` is not `status` restated: it also requires a `download_url`, because a job reporting completion with no archive is nothing the customer can act on. `404` for a site with no vendor hosting package, or one that is not the caller's. Requires `sites.view`.

パラメータ

名前タイプ必須これがその内容です
siteId (path)UuidはいSite ID (UUIDv7).

返信

名前タイプ必須これがその内容です
availablebooleanはいWhether this site runs on a hosting package with a standard-backup surface at all. `false` renders nothing rather than an empty list.
retention_hoursintegerはい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.
backupWebsiteBackupはい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