hosting
PUT /v1/sites/{siteId}/offsite
Send this site's backups to a destination.
認証
ベアラー トークンとして API キーを送信します。キーには hosting.backup.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/offsite \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "destination_id": <string>, "retention_days": <integer<7, 30, 90, 180, 365>> }'ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Requires the add-on for this site and an account in good standing. Switching on copies the newest restorable backup (and any archives it depends on) at once, then every later backup. Changing destination drops copies still waiting for the old one; stored copies stay. Requires hosting.backup.manage.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
destination_id | string | はい | — |
retention_days | integer<7, 30, 90, 180, 365> | はい | — |
enabled | boolean | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
site_id | string | はい | — |
entitled | boolean | はい | — |
extra_code | string | はい | — |
retention_choices | integer[] | はい | — |
policy | object | はい | — |
copies | OffsiteCopy[] | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422