hosting

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

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

Všechny koncové body hosting

Všechny dokumenty pro vývojáře

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění sites.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

NázevTypPožadovánoCo to je
siteId (path)UuidAnoSite ID (UUIDv7).

Odpověď

NázevTypPožadovánoCo to je
accessstringAnoThe tail of the access log, or "" when the vendor published none.
errorstringAnoThe 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.
truncatedbooleanAnoEither stream was cut to its most recent bytes. Say so rather than implying the tail is the whole log.
unreadablebooleanAnoNeither log could be read. ⛔ Not the same as a site with no traffic, and must never render as two empty panes.
access_availablebooleanAnoWhether 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_availablebooleanAnoWhether the error log could be read — the same distinction, for error.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 429 · 503