hosting

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

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

所有 hosting 端点

所有开发者文档

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

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

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 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. ⭐ Serves sites on our own servers as well as vendor-hosted ones (W43-54). A fleet site's access log is its own account's file; its error log is filtered for that account on the host, so no other tenant's lines are ever transferred. Each stream carries its own *_available, because on the fleet one log can be readable while the other is not. Requires sites.view and sites.panel_access. 404 for a site that does not exist or is not in scope.

参数

名称类型必填内容简介
siteId (path)UuidSite ID (UUIDv7).

响应

名称类型必填内容简介
accessstringThe tail of the access log, or "" when the vendor published none.
errorstringThe 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.
truncatedbooleanEither stream was cut to its most recent bytes. Say so rather than implying the tail is the whole log.
unreadablebooleanNeither log could be read. ⛔ Not the same as a site with no traffic, and must never render as two empty panes.
access_availablebooleanWhether the access log could be read. On our own servers the two logs are different files and one can be readable while the other is not, so access: "" with this false means…
error_availablebooleanWhether the error log could be read — the same distinction, for error.

此端点可能返回的错误

401 · 403 · 404 · 429 · 503