hosting

GET /v1/sites/{siteId}/diagnostics

Run the site's health checks and report each one.

همه نقاط پایانی hosting

همهٔ مستندات توسعه‌دهندگان

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز sites.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

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

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی 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).

پاسخ

نامنوعالزامیچیست
dataSiteDiagnostic[]بله
worststring<ok, warn, fail, unknown>بلهThe most serious state present, for a summary badge. unknown ranks above ok and below warn.
checksstring[]بلهEvery check key, in display order, so a client can render a stable list.
statesstring[]بله

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 429 · 503