Skip to main content

Get Threat Protection Policy

1 min read
get/team/threat-protection
Request example
Response
get/team/threat-protection

Returns the effective threat protection policy for your organization. Enterprise feature; requires the feature to be enabled for your team.

Authorization

Authorizationstringheaderrequired#
Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Responses

application/json
Effective threat protection policy for the team's organization.
successboolean#
dataobject#
Show child attributes
modeenum<string>#
Threat protection mode. off disables checks; normal checks URLs against Google Web Risk (+2 credits per URL scanned).
Options:offnormal
riskScoreThresholdinteger#
Normalized score (0-100) at or above which a classifier verdict is blocked. Lower is stricter.

Range: 0–100

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.
failurePolicyenum<string>#
Behavior when the classifier is unreachable: closed blocks (default), open allows.
Options:openclosed
allowRequestOverridesboolean#
Whether individual requests may pass a threatProtection object. When false, such requests are rejected with 403.
configuredboolean#
Whether the organization has saved a policy (vs. serving defaults).
updatedAtstring#