Get Bot Detection settings

Get the Bot Detection configuration of your tenant.

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

Get Bot Detection settings

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/attack-protection/bot-detection \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/attack-protection/bot-detection"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}/api/v2/attack-protection/bot-detection', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/attack-protection/bot-detection",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/attack-protection/bot-detection"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/attack-protection/bot-detection")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/attack-protection/bot-detection")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

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

Réponse

200

application/json

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)