Web tamper protection page overview tamper-guard
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.
Pick an endpoint to see its example call on the right.
Authentication
Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.
X-API-Key
Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).
Conventions
Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.
Times are RFC 3339 (UTC); amounts are in cents.
Writes return 200/201/204 on success; duplicates of a unique key return 409.
/api/v2/tamper-guard/pagesList protected pages of all sites
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
page | integer | Page number, starting from 1 |
page_size | integer | Items per page |
tenant_id | integer | Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data |
site_id | integer | Only this site; an empty list when the site is not the caller's. |
q | string | Fuzzy search by site domain or page path (case-insensitive). |
changed | boolean | When true, only pages with a detected tampering (a non-empty last change). |
Web tamper protection page overview object
| Field | Type | Description |
|---|---|---|
base_at | string | When the site's baseline was last updated (whole site); null if never. |
domain | string | Primary domain of the site (first in its domain list; the site name when it has none). |
enabled | boolean | Whether tamper protection is switched on for the site; when off the pages are only a kept baseline and nothing is checked. |
gate | string | WAF Enhanced status of the site's tenant: full = baseline can be updated; readonly and basic = cannot. |
gate_expired_at | string | Administrator responses with gate_reason=expired only - when the platform WAF Enhanced license expired; not present in tenant responses. |
gate_owner | WafGateOwner | The owner of the site, in administrator responses only; tenant responses carry no one else's information. |
gate_packages | string[] | Administrator responses only - names of the owner's unexpired packages (at most 20); not present in tenant responses. |
gate_reason | WafGateReason | 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. |
kind | string | Which kind of scope the page comes from. |
last_change_action | string | What the node did the last time: replace = served the baseline page; log = recorded only (including the observation period). |
last_change_at | string | When tampering was last detected; null = none since the baseline. |
last_change_summary | string | Summary of the last change, e.g. link=bad.example.net, title. |
note | string | Why the page is not in the baseline, same values as SiteTamperPage.note; absent for included pages. |
observe_until | string | 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. |
path | string | Page path. |
site_id | integer | Site id. |
size | integer | Size of the baseline page in bytes. |
state | string | Page state: normal; tampered = tampering detected since the baseline; excluded = not in the baseline (see note). |
Responses and errors
Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"code": "validation_failed",
"detail": "Invalid request parameters",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name is required"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}