Version 2.4.7.20261116085428 · latest

Data leak protection site-leak-guards

Data leak protection of one site: checks pages, JSON and text returned by the origin for phone numbers, ID card numbers, bank card numbers, keys and error messages, and masks, blocks or replaces them with an error page; part of WAF Enhanced.

Pick an endpoint to see its example call on the right.

ProtectionAuthentication: User (some parameters admin only)3 endpoints

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.

GET/api/v2/site-leak-guards/{site_id}Get site data leak protection settings

Authentication: User (some parameters admin only)

PUT/api/v2/site-leak-guards/{site_id}Set site data leak protection

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
customSiteLeakGuardCustom[] Custom regular expressions, at most 16.
detectSiteLeakGuardDetect Action per built-in pattern; omit a pattern to not check it.
enabledRequiredboolean Whether enabled.
excludestring[] Path prefixes that are not checked, at most 32.
expected_updated_atstring Optimistic lock - the updated_at as the caller read it (when null, i.e. never set, use 1970-01-01T00:00:00Z). If it differs from the stored one, 409 stale_version is returned and nothing is saved; omit to skip the check.
observe_daysinteger Days observed after turning on.

Data leak protection object

FieldTypeDescription
customSiteLeakGuardCustom[] Custom regular expressions, at most 16.
detectSiteLeakGuardDetect Action per built-in pattern; omit a pattern to not check it.
enabledboolean Whether enabled.
excludestring[] Path prefixes that are not checked, at most 32.
expected_updated_atstring Optimistic lock - the updated_at as the caller read it (when null, i.e. never set, use 1970-01-01T00:00:00Z). If it differs from the stored one, 409 stale_version is returned and nothing is saved; omit to skip the check.
gatestring WAF Enhanced status of the site's tenant: full = editable; readonly = expired but within the read-only buffer (License.readonly_days, 7 days by default), still in effect but read-only; basic = not subscribed or past the buffer, nothing checked and settings kept.
read-onlyValues ["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"]
observe_daysinteger Days observed after turning on.
observe_untilstring End of the observation period; null = not observing (never on, or 0 days chosen).
read-only
site_idinteger Site ID
read-only
sourceProtectSiteSource Where the site's setting comes from: scheme = follows the scheme (changes when the scheme is saved); custom = set for this site alone (including turned off and rows migrated from before).
read-onlyValues ["scheme","custom"]
updated_atstring Version (null if never set); use expected_updated_at on update.
read-only

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.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "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"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command