hosting
PUT /v1/sites/{siteId}/cache
Set a site's server-side cache times.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/cache \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "css_seconds": <integer>, "image_seconds": <integer>, "javascript_seconds": <integer> }'ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Writes the three cache times a package lets a customer change, and returns the whole cache state so the card re-renders from the server's answer rather than from what it asked for. PUT because the body states the desired end state. ⛔⛔ All three classes are required, every time, and that is the contract rather than an oversight. The vendor replaces the stored policy with exactly the body it is given, so a request naming two classes deletes the third — silently, with a cheerful acknowledgement. Making the fields optional would put that footgun on the wire where every future client would find it. A value outside 0…31536000 seconds is refused 422 before the vendor is called, as is a package type whose cache settings it does not permit. 404 for a site with no vendor hosting package, or one that is not the caller's. Requires sites.view and sites.panel_access.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
css_seconds | integer | はい | How long stylesheets should be cached, in seconds. Zero is "do not cache". |
image_seconds | integer | はい | How long images should be cached, in seconds. |
javascript_seconds | integer | はい | How long scripts should be cached, in seconds. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
permitted | boolean | はい | Whether the package type exposes cache settings and the report at all. |
purge_permitted | boolean | はい | Whether a purge is permitted. Separate from permitted on purpose: the purge was measured working on a package whose cache settings and report the vendor refuses. |
css_seconds | integer | はい | How long stylesheets are cached. |
image_seconds | integer | はい | How long images are cached. |
javascript_seconds | integer | はい | How long scripts are cached. |
reported | object | はい | Every asset class the vendor reported, keyed by its own name, including the classes that cannot be written. ⛔ Read-only on a client: writing them deletes them, because the vendor… |
report_available | boolean | はい | Whether the cacheability report could be read. False renders an explanation rather than an empty table, so "nothing has been seen yet" and "not part of this plan" never look… |
report | SiteCacheReportRow[] | はい | What the platform did with the URLs it has seen. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503