Bot Management

Get Zone Bot Management Config

GET/zones/{zone_id}/bot_management

Update Zone Bot Management Config

PUT/zones/{zone_id}/bot_management

ModelsExpand Collapse

BotFightModeConfiguration = object { ai_bots_protection, cf_robots_variant, crawler_protection, 5 more }

ai_bots_protection: optional "block" or "disabled" or "only_on_ad_pages"

Enable rule to block AI Scrapers and Crawlers. Please note the value only_on_ad_pages is currently not available for Enterprise customers.

One of the following:

"block"

"disabled"

"only_on_ad_pages"

cf_robots_variant: optional "off" or "policy_only"

Specifies the Robots Access Control License variant to use.

One of the following:

"off"

"policy_only"

crawler_protection: optional "enabled" or "disabled"

Enable rule to punish AI Scrapers and Crawlers via a link maze.

One of the following:

"enabled"

"disabled"

enable_js: optional boolean

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

fight_mode: optional boolean

Whether to enable Bot Fight Mode.

is_robots_txt_managed: optional boolean

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

stale_zone_configuration: optional object { optimize_wordpress, sbfm_definitely_automated, sbfm_likely_automated, 3 more }

A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.

optimize_wordpress: optional boolean

Indicates that the zone's wordpress optimization for SBFM is turned on.

sbfm_definitely_automated: optional string

Indicates that the zone's definitely automated requests are being blocked or challenged.

sbfm_likely_automated: optional string

Indicates that the zone's likely automated requests are being blocked or challenged.

sbfm_static_resource_protection: optional string

Indicates that the zone's static resource protection is turned on.

sbfm_verified_bots: optional string

Indicates that the zone's verified bot requests are being blocked.

suppress_session_score: optional boolean

Indicates that the zone's session score tracking is disabled.

using_latest_model: optional boolean

A read-only field that indicates whether the zone currently is running the latest ML model.

SubscriptionConfiguration = object { ai_bots_protection, auto_update_model, bm_cookie_enabled, 7 more }

ai_bots_protection: optional "block" or "disabled" or "only_on_ad_pages"

Enable rule to block AI Scrapers and Crawlers. Please note the value only_on_ad_pages is currently not available for Enterprise customers.

One of the following:

"block"

"disabled"

"only_on_ad_pages"

auto_update_model: optional boolean

Automatically update to the newest bot detection models created by Cloudflare as they are released. Learn more.

bm_cookie_enabled: optional boolean

Indicates that the bot management cookie can be placed on end user devices accessing the site. Defaults to true

cf_robots_variant: optional "off" or "policy_only"

Specifies the Robots Access Control License variant to use.

One of the following:

"off"

"policy_only"

crawler_protection: optional "enabled" or "disabled"

Enable rule to punish AI Scrapers and Crawlers via a link maze.

One of the following:

"enabled"

"disabled"

enable_js: optional boolean

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

is_robots_txt_managed: optional boolean

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

stale_zone_configuration: optional object { fight_mode, optimize_wordpress, sbfm_definitely_automated, 3 more }

A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.

fight_mode: optional boolean

Indicates that the zone's Bot Fight Mode is turned on.

optimize_wordpress: optional boolean

Indicates that the zone's wordpress optimization for SBFM is turned on.

sbfm_definitely_automated: optional string

Indicates that the zone's definitely automated requests are being blocked or challenged.

sbfm_likely_automated: optional string

Indicates that the zone's likely automated requests are being blocked or challenged.

sbfm_static_resource_protection: optional string

Indicates that the zone's static resource protection is turned on.

sbfm_verified_bots: optional string

Indicates that the zone's verified bot requests are being blocked.

suppress_session_score: optional boolean

Whether to disable tracking the highest bot score for a session in the Bot Management cookie.

using_latest_model: optional boolean

A read-only field that indicates whether the zone currently is running the latest ML model.

SuperBotFightModeDefinitelyConfiguration = object { ai_bots_protection, cf_robots_variant, crawler_protection, 8 more }

ai_bots_protection: optional "block" or "disabled" or "only_on_ad_pages"

Enable rule to block AI Scrapers and Crawlers. Please note the value only_on_ad_pages is currently not available for Enterprise customers.

One of the following:

"block"

"disabled"

"only_on_ad_pages"

cf_robots_variant: optional "off" or "policy_only"

Specifies the Robots Access Control License variant to use.

One of the following:

"off"

"policy_only"

crawler_protection: optional "enabled" or "disabled"

Enable rule to punish AI Scrapers and Crawlers via a link maze.

One of the following:

"enabled"

"disabled"

enable_js: optional boolean

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

is_robots_txt_managed: optional boolean

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

optimize_wordpress: optional boolean

Whether to optimize Super Bot Fight Mode protections for Wordpress.

sbfm_definitely_automated: optional "allow" or "block" or "managed_challenge"

Super Bot Fight Mode (SBFM) action to take on definitely automated requests.

One of the following:

"allow"

"block"

"managed_challenge"

sbfm_static_resource_protection: optional boolean

Super Bot Fight Mode (SBFM) to enable static resource protection. Enable if static resources on your application need bot protection. Note: Static resource protection can also result in legitimate traffic being blocked.

sbfm_verified_bots: optional "allow" or "block"

Super Bot Fight Mode (SBFM) action to take on verified bots requests.

One of the following:

"allow"

"block"

stale_zone_configuration: optional object { fight_mode, sbfm_likely_automated }

A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.

fight_mode: optional boolean

Indicates that the zone's Bot Fight Mode is turned on.

sbfm_likely_automated: optional string

Indicates that the zone's likely automated requests are being blocked or challenged.

using_latest_model: optional boolean

A read-only field that indicates whether the zone currently is running the latest ML model.

SuperBotFightModeLikelyConfiguration = object { ai_bots_protection, cf_robots_variant, crawler_protection, 9 more }

ai_bots_protection: optional "block" or "disabled" or "only_on_ad_pages"

Enable rule to block AI Scrapers and Crawlers. Please note the value only_on_ad_pages is currently not available for Enterprise customers.

One of the following:

"block"

"disabled"

"only_on_ad_pages"

cf_robots_variant: optional "off" or "policy_only"

Specifies the Robots Access Control License variant to use.

One of the following:

"off"

"policy_only"

crawler_protection: optional "enabled" or "disabled"

Enable rule to punish AI Scrapers and Crawlers via a link maze.

One of the following:

"enabled"

"disabled"

enable_js: optional boolean

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

is_robots_txt_managed: optional boolean

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

optimize_wordpress: optional boolean

Whether to optimize Super Bot Fight Mode protections for Wordpress.

sbfm_definitely_automated: optional "allow" or "block" or "managed_challenge"

Super Bot Fight Mode (SBFM) action to take on definitely automated requests.

One of the following:

"allow"

"block"

"managed_challenge"

sbfm_likely_automated: optional "allow" or "block" or "managed_challenge"

Super Bot Fight Mode (SBFM) action to take on likely automated requests.

One of the following:

"allow"

"block"

"managed_challenge"

sbfm_static_resource_protection: optional boolean

sbfm_verified_bots: optional "allow" or "block"

Super Bot Fight Mode (SBFM) action to take on verified bots requests.

One of the following:

"allow"

"block"

stale_zone_configuration: optional object { fight_mode }

A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.

fight_mode: optional boolean

Indicates that the zone's Bot Fight Mode is turned on.

using_latest_model: optional boolean

A read-only field that indicates whether the zone currently is running the latest ML model.

BotManagementGetResponse = BotFightModeConfiguration { ai_bots_protection, cf_robots_variant, crawler_protection, 5 more } or SuperBotFightModeDefinitelyConfiguration { ai_bots_protection, cf_robots_variant, crawler_protection, 8 more } or SuperBotFightModeLikelyConfiguration { ai_bots_protection, cf_robots_variant, crawler_protection, 9 more } or SubscriptionConfiguration { ai_bots_protection, auto_update_model, bm_cookie_enabled, 7 more }

One of the following:

BotFightModeConfiguration = object { ai_bots_protection, cf_robots_variant, crawler_protection, 5 more }

ai_bots_protection: optional "block" or "disabled" or "only_on_ad_pages"

Enable rule to block AI Scrapers and Crawlers. Please note the value only_on_ad_pages is currently not available for Enterprise customers.

One of the following:

"block"

"disabled"

"only_on_ad_pages"

cf_robots_variant: optional "off" or "policy_only"

Specifies the Robots Access Control License variant to use.

One of the following:

"off"

"policy_only"

crawler_protection: optional "enabled" or "disabled"

Enable rule to punish AI Scrapers and Crawlers via a link maze.

One of the following:

"enabled"

"disabled"

enable_js: optional boolean

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

fight_mode: optional boolean

Whether to enable Bot Fight Mode.

is_robots_txt_managed: optional boolean

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

stale_zone_configuration: optional object { optimize_wordpress, sbfm_definitely_automated, sbfm_likely_automated, 3 more }

A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.

optimize_wordpress: optional boolean

Indicates that the zone's wordpress optimization for SBFM is turned on.

sbfm_definitely_automated: optional string

Indicates that the zone's definitely automated requests are being blocked or challenged.

sbfm_likely_automated: optional string

Indicates that the zone's likely automated requests are being blocked or challenged.

sbfm_static_resource_protection: optional string

Indicates that the zone's static resource protection is turned on.

sbfm_verified_bots: optional string

Indicates that the zone's verified bot requests are being blocked.

suppress_session_score: optional boolean

Indicates that the zone's session score tracking is disabled.

using_latest_model: optional boolean

A read-only field that indicates whether the zone currently is running the latest ML model.

SuperBotFightModeDefinitelyConfiguration = object { ai_bots_protection, cf_robots_variant, crawler_protection, 8 more }

ai_bots_protection: optional "block" or "disabled" or "only_on_ad_pages"

Enable rule to block AI Scrapers and Crawlers. Please note the value only_on_ad_pages is currently not available for Enterprise customers.

One of the following:

"block"

"disabled"

"only_on_ad_pages"

cf_robots_variant: optional "off" or "policy_only"

Specifies the Robots Access Control License variant to use.

One of the following:

"off"

"policy_only"

crawler_protection: optional "enabled" or "disabled"

Enable rule to punish AI Scrapers and Crawlers via a link maze.

One of the following:

"enabled"

"disabled"

enable_js: optional boolean

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

is_robots_txt_managed: optional boolean

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

optimize_wordpress: optional boolean

Whether to optimize Super Bot Fight Mode protections for Wordpress.

sbfm_definitely_automated: optional "allow" or "block" or "managed_challenge"

Super Bot Fight Mode (SBFM) action to take on definitely automated requests.

One of the following:

"allow"

"block"

"managed_challenge"

sbfm_static_resource_protection: optional boolean

sbfm_verified_bots: optional "allow" or "block"

Super Bot Fight Mode (SBFM) action to take on verified bots requests.

One of the following:

"allow"

"block"

stale_zone_configuration: optional object { fight_mode, sbfm_likely_automated }

A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.

fight_mode: optional boolean

Indicates that the zone's Bot Fight Mode is turned on.

sbfm_likely_automated: optional string

Indicates that the zone's likely automated requests are being blocked or challenged.

using_latest_model: optional boolean

A read-only field that indicates whether the zone currently is running the latest ML model.

SuperBotFightModeLikelyConfiguration = object { ai_bots_protection, cf_robots_variant, crawler_protection, 9 more }

ai_bots_protection: optional "block" or "disabled" or "only_on_ad_pages"

Enable rule to block AI Scrapers and Crawlers. Please note the value only_on_ad_pages is currently not available for Enterprise customers.

One of the following:

"block"

"disabled"

"only_on_ad_pages"

cf_robots_variant: optional "off" or "policy_only"

Specifies the Robots Access Control License variant to use.

One of the following:

"off"

"policy_only"

crawler_protection: optional "enabled" or "disabled"

Enable rule to punish AI Scrapers and Crawlers via a link maze.

One of the following:

"enabled"

"disabled"

enable_js: optional boolean

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

is_robots_txt_managed: optional boolean

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

optimize_wordpress: optional boolean

Whether to optimize Super Bot Fight Mode protections for Wordpress.

sbfm_definitely_automated: optional "allow" or "block" or "managed_challenge"

Super Bot Fight Mode (SBFM) action to take on definitely automated requests.

One of the following:

"allow"

"block"

"managed_challenge"

sbfm_likely_automated: optional "allow" or "block" or "managed_challenge"

Super Bot Fight Mode (SBFM) action to take on likely automated requests.

One of the following:

"allow"

"block"

"managed_challenge"

sbfm_static_resource_protection: optional boolean

sbfm_verified_bots: optional "allow" or "block"

Super Bot Fight Mode (SBFM) action to take on verified bots requests.

One of the following:

"allow"

"block"

stale_zone_configuration: optional object { fight_mode }

A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.

fight_mode: optional boolean

Indicates that the zone's Bot Fight Mode is turned on.

using_latest_model: optional boolean

A read-only field that indicates whether the zone currently is running the latest ML model.

SubscriptionConfiguration = object { ai_bots_protection, auto_update_model, bm_cookie_enabled, 7 more }

ai_bots_protection: optional "block" or "disabled" or "only_on_ad_pages"

Enable rule to block AI Scrapers and Crawlers. Please note the value only_on_ad_pages is currently not available for Enterprise customers.

One of the following:

"block"

"disabled"

"only_on_ad_pages"

auto_update_model: optional boolean

Automatically update to the newest bot detection models created by Cloudflare as they are released. Learn more.

bm_cookie_enabled: optional boolean

Indicates that the bot management cookie can be placed on end user devices accessing the site. Defaults to true

cf_robots_variant: optional "off" or "policy_only"

Specifies the Robots Access Control License variant to use.

One of the following:

"off"

"policy_only"

crawler_protection: optional "enabled" or "disabled"

Enable rule to punish AI Scrapers and Crawlers via a link maze.

One of the following:

"enabled"

"disabled"

enable_js: optional boolean

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

is_robots_txt_managed: optional boolean

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

stale_zone_configuration: optional object { fight_mode, optimize_wordpress, sbfm_definitely_automated, 3 more }

A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.

fight_mode: optional boolean

Indicates that the zone's Bot Fight Mode is turned on.

optimize_wordpress: optional boolean

Indicates that the zone's wordpress optimization for SBFM is turned on.

sbfm_definitely_automated: optional string

Indicates that the zone's definitely automated requests are being blocked or challenged.

sbfm_likely_automated: optional string

Indicates that the zone's likely automated requests are being blocked or challenged.

sbfm_static_resource_protection: optional string

Indicates that the zone's static resource protection is turned on.

sbfm_verified_bots: optional string

Indicates that the zone's verified bot requests are being blocked.

suppress_session_score: optional boolean

Whether to disable tracking the highest bot score for a session in the Bot Management cookie.

using_latest_model: optional boolean

A read-only field that indicates whether the zone currently is running the latest ML model.

BotManagementUpdateResponse = BotFightModeConfiguration { ai_bots_protection, cf_robots_variant, crawler_protection, 5 more } or SuperBotFightModeDefinitelyConfiguration { ai_bots_protection, cf_robots_variant, crawler_protection, 8 more } or SuperBotFightModeLikelyConfiguration { ai_bots_protection, cf_robots_variant, crawler_protection, 9 more } or SubscriptionConfiguration { ai_bots_protection, auto_update_model, bm_cookie_enabled, 7 more }

One of the following:

BotFightModeConfiguration = object { ai_bots_protection, cf_robots_variant, crawler_protection, 5 more }

ai_bots_protection: optional "block" or "disabled" or "only_on_ad_pages"

Enable rule to block AI Scrapers and Crawlers. Please note the value only_on_ad_pages is currently not available for Enterprise customers.

One of the following:

"block"

"disabled"

"only_on_ad_pages"

cf_robots_variant: optional "off" or "policy_only"

Specifies the Robots Access Control License variant to use.

One of the following:

"off"

"policy_only"

crawler_protection: optional "enabled" or "disabled"

Enable rule to punish AI Scrapers and Crawlers via a link maze.

One of the following:

"enabled"

"disabled"

enable_js: optional boolean

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

fight_mode: optional boolean

Whether to enable Bot Fight Mode.

is_robots_txt_managed: optional boolean

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

stale_zone_configuration: optional object { optimize_wordpress, sbfm_definitely_automated, sbfm_likely_automated, 3 more }

A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.

optimize_wordpress: optional boolean

Indicates that the zone's wordpress optimization for SBFM is turned on.

sbfm_definitely_automated: optional string

Indicates that the zone's definitely automated requests are being blocked or challenged.

sbfm_likely_automated: optional string

Indicates that the zone's likely automated requests are being blocked or challenged.

sbfm_static_resource_protection: optional string

Indicates that the zone's static resource protection is turned on.

sbfm_verified_bots: optional string

Indicates that the zone's verified bot requests are being blocked.

suppress_session_score: optional boolean

Indicates that the zone's session score tracking is disabled.

using_latest_model: optional boolean

A read-only field that indicates whether the zone currently is running the latest ML model.

SuperBotFightModeDefinitelyConfiguration = object { ai_bots_protection, cf_robots_variant, crawler_protection, 8 more }

ai_bots_protection: optional "block" or "disabled" or "only_on_ad_pages"

Enable rule to block AI Scrapers and Crawlers. Please note the value only_on_ad_pages is currently not available for Enterprise customers.

One of the following:

"block"

"disabled"

"only_on_ad_pages"

cf_robots_variant: optional "off" or "policy_only"

Specifies the Robots Access Control License variant to use.

One of the following:

"off"

"policy_only"

crawler_protection: optional "enabled" or "disabled"

Enable rule to punish AI Scrapers and Crawlers via a link maze.

One of the following:

"enabled"

"disabled"

enable_js: optional boolean

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

is_robots_txt_managed: optional boolean

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

optimize_wordpress: optional boolean

Whether to optimize Super Bot Fight Mode protections for Wordpress.

sbfm_definitely_automated: optional "allow" or "block" or "managed_challenge"

Super Bot Fight Mode (SBFM) action to take on definitely automated requests.

One of the following:

"allow"

"block"

"managed_challenge"

sbfm_static_resource_protection: optional boolean

sbfm_verified_bots: optional "allow" or "block"

Super Bot Fight Mode (SBFM) action to take on verified bots requests.

One of the following:

"allow"

"block"

stale_zone_configuration: optional object { fight_mode, sbfm_likely_automated }

A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.

fight_mode: optional boolean

Indicates that the zone's Bot Fight Mode is turned on.

sbfm_likely_automated: optional string

Indicates that the zone's likely automated requests are being blocked or challenged.

using_latest_model: optional boolean

A read-only field that indicates whether the zone currently is running the latest ML model.

SuperBotFightModeLikelyConfiguration = object { ai_bots_protection, cf_robots_variant, crawler_protection, 9 more }

ai_bots_protection: optional "block" or "disabled" or "only_on_ad_pages"

Enable rule to block AI Scrapers and Crawlers. Please note the value only_on_ad_pages is currently not available for Enterprise customers.

One of the following:

"block"

"disabled"

"only_on_ad_pages"

cf_robots_variant: optional "off" or "policy_only"

Specifies the Robots Access Control License variant to use.

One of the following:

"off"

"policy_only"

crawler_protection: optional "enabled" or "disabled"

Enable rule to punish AI Scrapers and Crawlers via a link maze.

One of the following:

"enabled"

"disabled"

enable_js: optional boolean

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

is_robots_txt_managed: optional boolean

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

optimize_wordpress: optional boolean

Whether to optimize Super Bot Fight Mode protections for Wordpress.

sbfm_definitely_automated: optional "allow" or "block" or "managed_challenge"

Super Bot Fight Mode (SBFM) action to take on definitely automated requests.

One of the following:

"allow"

"block"

"managed_challenge"

sbfm_likely_automated: optional "allow" or "block" or "managed_challenge"

Super Bot Fight Mode (SBFM) action to take on likely automated requests.

One of the following:

"allow"

"block"

"managed_challenge"

sbfm_static_resource_protection: optional boolean

sbfm_verified_bots: optional "allow" or "block"

Super Bot Fight Mode (SBFM) action to take on verified bots requests.

One of the following:

"allow"

"block"

stale_zone_configuration: optional object { fight_mode }

A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.

fight_mode: optional boolean

Indicates that the zone's Bot Fight Mode is turned on.

using_latest_model: optional boolean

A read-only field that indicates whether the zone currently is running the latest ML model.

SubscriptionConfiguration = object { ai_bots_protection, auto_update_model, bm_cookie_enabled, 7 more }

ai_bots_protection: optional "block" or "disabled" or "only_on_ad_pages"

Enable rule to block AI Scrapers and Crawlers. Please note the value only_on_ad_pages is currently not available for Enterprise customers.

One of the following:

"block"

"disabled"

"only_on_ad_pages"

auto_update_model: optional boolean

Automatically update to the newest bot detection models created by Cloudflare as they are released. Learn more.

bm_cookie_enabled: optional boolean

Indicates that the bot management cookie can be placed on end user devices accessing the site. Defaults to true

cf_robots_variant: optional "off" or "policy_only"

Specifies the Robots Access Control License variant to use.

One of the following:

"off"

"policy_only"

crawler_protection: optional "enabled" or "disabled"

Enable rule to punish AI Scrapers and Crawlers via a link maze.

One of the following:

"enabled"

"disabled"

enable_js: optional boolean

Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.

is_robots_txt_managed: optional boolean

Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.

stale_zone_configuration: optional object { fight_mode, optimize_wordpress, sbfm_definitely_automated, 3 more }

A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.

fight_mode: optional boolean

Indicates that the zone's Bot Fight Mode is turned on.

optimize_wordpress: optional boolean

Indicates that the zone's wordpress optimization for SBFM is turned on.

sbfm_definitely_automated: optional string

Indicates that the zone's definitely automated requests are being blocked or challenged.

sbfm_likely_automated: optional string

Indicates that the zone's likely automated requests are being blocked or challenged.

sbfm_static_resource_protection: optional string

Indicates that the zone's static resource protection is turned on.

sbfm_verified_bots: optional string

Indicates that the zone's verified bot requests are being blocked.

suppress_session_score: optional boolean

Whether to disable tracking the highest bot score for a session in the Bot Management cookie.

using_latest_model: optional boolean

A read-only field that indicates whether the zone currently is running the latest ML model.

Bot ManagementFeedback

List zone feedback reports

GET/zones/{zone_id}/bot_management/feedback

Submit a feedback report

POST/zones/{zone_id}/bot_management/feedback

ModelsExpand Collapse

FeedbackReport = object { description, expression, first_request_seen_at, 8 more }

description: string

expression: string

Wirefilter expression describing the traffic being reported.

first_request_seen_at: string

formatdate-time

last_request_seen_at: string

formatdate-time

requests: number

formatint64

requests_by_attribute: RequestsByAttribute { metric, requests }

Top attributes contributing to the feedback sample. Keys include topASNs, topCountries, topHosts, topIPs, topJA3Hashes, topJA4s, topPaths, topUserAgents.

requests_by_score: RequestsByScore

Map of bot scores (1-99) to request counts. Sum must equal requests.

requests_by_score_src: RequestsByScoreSrc

Map of score source to request counts. Sum must equal requests.

type: FeedbackType

Type of feedback report.

created_at: optional string

formatdate-time

subtype: optional string

FeedbackType = "false_positive" or "false_negative"

Type of feedback report.

One of the following:

"false_positive"

"false_negative"

MetricRequests = object { metric, requests }

metric: string

requests: number

formatint64

RequestsByAttribute = map[array of MetricRequests { metric, requests } ]

Top attributes contributing to the feedback sample. Keys include topASNs, topCountries, topHosts, topIPs, topJA3Hashes, topJA4s, topPaths, topUserAgents.

metric: string

requests: number

formatint64

RequestsByScore = map[number]

Map of bot scores (1-99) to request counts. Sum must equal requests.

RequestsByScoreSrc = map[number]

Map of score source to request counts. Sum must equal requests.

FeedbackListResponse = array of FeedbackReport { description, expression, first_request_seen_at, 8 more }

description: string

expression: string

Wirefilter expression describing the traffic being reported.

first_request_seen_at: string

formatdate-time

last_request_seen_at: string

formatdate-time

requests: number

formatint64

requests_by_attribute: RequestsByAttribute { metric, requests }

Top attributes contributing to the feedback sample. Keys include topASNs, topCountries, topHosts, topIPs, topJA3Hashes, topJA4s, topPaths, topUserAgents.

requests_by_score: RequestsByScore

Map of bot scores (1-99) to request counts. Sum must equal requests.

requests_by_score_src: RequestsByScoreSrc

Map of score source to request counts. Sum must equal requests.

type: FeedbackType

Type of feedback report.

created_at: optional string

formatdate-time

subtype: optional string