hosting
GET /v1/sites/{siteId}/diagnostics
Run the site's health checks and report each one.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/diagnostics \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The equivalent of the hosting panel's own auto-diagnostics page: nameservers, mail DNS, a live TLS fetch, domain reputation across five blocklists, the last malware scan, file permissions and the error log. ⛔ Not one vendor endpoint — an aggregate of six concurrent reads, which is why each row carries its **own** state. A check that could not run reports `unknown`, deliberately distinct from `ok`: collapsing them would reassure a customer about something never checked. ⛔ Rows carry keys and data, never prose — the sentence is the client's to translate. Requires `sites.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | SiteDiagnostic[] | はい | — |
worst | string<ok, warn, fail, unknown> | はい | The most serious state present, for a summary badge. `unknown` ranks above `ok` and below `warn`. |
checks | string[] | はい | Every check key, in display order, so a client can render a stable list. |
states | string[] | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 429 · 503