Passer au contenu principal
GET
/
attack-protection
/
bot-detection
Get Bot Detection settings
curl --request GET \
  --url https://{tenantDomain}/api/v2/attack-protection/bot-detection \
  --header 'Authorization: Bearer <token>'
{
  "bot_detection_level": "low",
  "challenge_password_policy": "never",
  "challenge_passwordless_policy": "never",
  "challenge_password_reset_policy": "never",
  "allowlist": [
    "127.0.0.1"
  ],
  "monitoring_mode_enabled": true
}

Autorisations

​
Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Réponse

Bot detection configuration retrieved successfully.

​
bot_detection_level
enum<string>
requis

The level of bot detection sensitivity

Options disponibles:
low,
medium,
high
​
challenge_password_policy
enum<string>
requis

The policy that defines how often to show CAPTCHA

Options disponibles:
never,
when_risky,
always
​
challenge_passwordless_policy
enum<string>
requis

The policy that defines how often to show CAPTCHA

Options disponibles:
never,
when_risky,
always
​
challenge_password_reset_policy
enum<string>
requis

The policy that defines how often to show CAPTCHA

Options disponibles:
never,
when_risky,
always
​
allowlist
(string<ipv4> | string<ipv6> | string<cidr> | string<ipv6_cidr>)[]
requis

List of IP addresses or CIDR blocks to allowlist

IPv4 address

​
monitoring_mode_enabled
boolean
requis

Whether monitoring mode is enabled (logs but does not block)