Update Bot Detection settings

Update the Bot Detection configuration of your tenant.

PATCH https://{tenantDomain}/api/v2/attack-protection/bot-detection

Update Bot Detection settings

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/attack-protection/bot-detection \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
}
'

200

{
  "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

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Corps

application/jsonapplication/x-www-form-urlencoded

bot_detection_level · enum<string>

The level of bot detection sensitivity

Options disponibles: low, medium, high

challenge_password_policy · enum<string>

The policy that defines how often to show CAPTCHA

Options disponibles: never, when_risky, always

challenge_passwordless_policy · enum<string>

The policy that defines how often to show CAPTCHA

Options disponibles: never, when_risky, always

challenge_password_reset_policy · enum<string>

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>)[]

List of IP addresses or CIDR blocks to allowlist

IPv4 address

monitoring_mode_enabled · boolean

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

Réponse

200

application/json

Bot detection configuration successfully updated.

bot_detection_level · enum<string>

The level of bot detection sensitivity

Options disponibles: low, medium, high

challenge_password_policy · enum<string>

The policy that defines how often to show CAPTCHA

Options disponibles: never, when_risky, always

challenge_passwordless_policy · enum<string>

The policy that defines how often to show CAPTCHA

Options disponibles: never, when_risky, always

challenge_password_reset_policy · enum<string>

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>)[]

List of IP addresses or CIDR blocks to allowlist

IPv4 address

monitoring_mode_enabled · boolean

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