v1

latestOpenAPI 3.0.02026-07-224452146.0 KB

Threat Protection

Update the team's threat protection policy

Full-document update. Unspecified fields reset to defaults. Enterprise feature, team admins only.

put/team/threat-protection

Request body

mode'off' | 'normal' required

Threat protection mode. off disables checks; normal checks URLs against Google Web Risk (+2 credits per URL scanned).

riskScoreThresholdinteger

Normalized score (0-100) at or above which a classifier verdict is blocked. Lower is stricter.

blackliststring[]

Exact domains or globs (e.g. *.example.com) always blocked, without a classifier call.

whiteliststring[]

Exact domains or globs always allowed. Wins over every other rule.

blockedTldsstring[]

Top-level domains to block outright, lowercase without a leading dot.

failurePolicy'open' | 'closed'

Behavior when the classifier is unreachable: closed blocks (default), open allows.

allowRequestOverridesboolean

Whether individual requests may pass a threatProtection object. When false, such requests are rejected with 403.

Example request

{
  "mode": "normal",
  "riskScoreThreshold": 75,
  "blacklist": [
    "*.risky.example"
  ],
  "whitelist": [
    "*.trusted.example"
  ],
  "blockedTlds": [
    "zip"
  ],
  "failurePolicy": "closed",
  "allowRequestOverrides": true
}

Response

Effective threat protection policy for the team's organization.

successboolean

Example response

{
  "success": true,
  "data": {
    "mode": "normal",
    "riskScoreThreshold": 75,
    "blacklist": [
      "*.risky.example"
    ],
    "whitelist": [
      "*.trusted.example"
    ],
    "blockedTlds": [
      "zip"
    ],
    "failurePolicy": "closed",
    "allowRequestOverrides": true,
    "configured": true
  }
}