Version 2.1.1792967583 · latest Download OpenAPI Markdown

Web tamper protection page overview

All protected pages across sites (site, path, scope, baseline time, state, last change) without picking a site first; tenants see their own sites only and may filter by site.

tamper-guardProtectionAuthentication: User (some parameters admin only)1 endpoints

List protected pages of all sites

GET/api/v2/tamper-guard/pages
Authentication: User (some parameters admin only)

Query parameters

FieldTypeRequiredDescription
pageinteger— Page number, starting from 1
Default 1
page_sizeinteger— Items per page
Default 20
tenant_idinteger— Admin only: filter by tenant. Ignored for tenant credentials, which only see their own tenant's data
site_idinteger— Only this site; an empty list when the site is not the caller's.
qstring— Fuzzy search by site domain or page path (case-insensitive).
changedboolean— When true, only pages with a detected tampering (a non-empty last change).

Web tamper protection page overview object

FieldTypeRequiredDescription
base_atstring— When the site's baseline was last updated (whole site); null if never.
domainstring— Primary domain of the site (first in its domain list; the site name when it has none).
enabledboolean— Whether tamper protection is switched on for the site; when off the pages are only a kept baseline and nothing is checked.
gatestring— WAF Enhanced status of the site's tenant: full = baseline can be updated; readonly and basic = cannot.
Values ["full","readonly","basic"]
gate_expired_atstring— Administrator responses with gate_reason=expired only - when the platform WAF Enhanced license expired; not present in tenant responses.
read-only
gate_ownerWafGateOwner— The owner of the site, in administrator responses only; tenant responses carry no one else's information.
read-only
gate_packagesstring[]— Administrator responses only - names of the owner's unexpired packages (at most 20); not present in tenant responses.
read-only
gate_reasonWafGateReason— Why WAF Enhanced (waf_enhanced) is not in effect; absent when gate is full or readonly. package = the platform is licensed but the owner has no unexpired package that includes WAF Enhanced; license = the platform has not enabled it (never licensed, revoked by the provider, or the license was disabled); expired = the platform license has expired and its read-only buffer period (License.readonly_days, default 7 days) has passed, so it fell back to basic.
read-onlyValues ["package","license","expired"]
kindstring— Which kind of scope the page comes from.
Values ["home","page","dir"]
last_change_actionstring— What the node did the last time: replace = served the baseline page; log = recorded only (including the observation period).
Values ["replace","log"]
last_change_atstring— When tampering was last detected; null = none since the baseline.
last_change_summarystring— Summary of the last change, e.g. link=bad.example.net, title.
notestring— Why the page is not in the baseline, same values as SiteTamperPage.note; absent for included pages.
Values ["too_large","site_limit","fetch_failed","not_html"]
observe_untilstring— End of the site's tamper-protection observation period; set only while protection is on and observing (same as SiteTamperGuard.observe_until), null when off or never observing; an already-passed deadline is returned as is, the caller compares it with the current time.
pathstring— Page path.
site_idinteger— Site id.
sizeinteger— Size of the baseline page in bytes.
statestring— Page state: normal; tampered = tampering detected since the baseline; excluded = not in the baseline (see note).
Values ["normal","tampered","excluded"]