hosting

GET `/v1/sites/{siteId}/web-logs`

Get the tail of a site's access and error logs.

احراز هویت

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

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

امتحان کنید

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

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

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

The customer's own web-server logs for their own site. Until this endpoint existed a customer could not see their access log **at all**, which is why *"why is my site slow"* was a support ticket rather than a tab. ⛔ **The path is `/web-logs`, deliberately not `/logs`.** `/v1/ops/logs` is Loki and staff-only, and two endpoints differing by a prefix are two endpoints somebody confuses in a runbook at three in the morning. ⛔ `access` is a list of the customer's **visitors'** IP addresses — personal data held under the customer's lawful basis, not ours. It is served only to a principal entitled to the site, must not be cached by the client, and both streams are cut to their most recent bytes so a busy site cannot answer with tens of megabytes; `truncated` says so rather than implying the tail is the whole. `unreadable` is `true` when the vendor answered with a body naming neither log — which is **not** the same as a site with no traffic, and must never render as two empty panes. Requires `sites.view` **and** `sites.panel_access`. `404` for a site with no managed hosting package.

پارامترها

نام	نوع	الزامی	چیست
`siteId (path)`	`Uuid`	بله	Site ID (UUIDv7).

پاسخ

نام	نوع	الزامی	چیست
`access`	`string`	بله	The tail of the access log, or `""` when the vendor published none.
`error`	`string`	بله	The tail of the error log, or `""` when the vendor published none. On a misconfigured application it can carry absolute paths and credentials in a stack trace.
`truncated`	`boolean`	بله	Either stream was cut to its most recent bytes. Say so rather than implying the tail is the whole log.
`unreadable`	`boolean`	بله	The vendor answered with a body naming neither log. ⛔ Not the same as a site with no traffic, and must never render as two empty panes.

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

401 · 403 · 404 · 429 · 503

GET /v1/sites/{siteId}/web-logs