## Get Zone Bot Management Config `client.botManagement.get(BotManagementGetParamsparams, RequestOptionsoptions?): BotManagementGetResponse` **get** `/zones/{zone_id}/bot_management` Retrieve a zone's Bot Management Config ### Parameters - `params: BotManagementGetParams` - `zone_id: string` Identifier. ### Returns - `BotManagementGetResponse = BotFightModeConfiguration | SuperBotFightModeDefinitelyConfiguration | SuperBotFightModeLikelyConfiguration | SubscriptionConfiguration` - `BotFightModeConfiguration` - `ai_bots_protection?: "block" | "disabled" | "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. - `"block"` - `"disabled"` - `"only_on_ad_pages"` - `cf_robots_variant?: "off" | "policy_only"` Specifies the Robots Access Control License variant to use. - `"off"` - `"policy_only"` - `crawler_protection?: "enabled" | "disabled"` Enable rule to punish AI Scrapers and Crawlers via a link maze. - `"enabled"` - `"disabled"` - `enable_js?: boolean` Use lightweight, invisible JavaScript detections to improve Bot Management. [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). - `fight_mode?: boolean` Whether to enable Bot Fight Mode. - `is_robots_txt_managed?: 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?: StaleZoneConfiguration` 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?: boolean` Indicates that the zone's wordpress optimization for SBFM is turned on. - `sbfm_definitely_automated?: string` Indicates that the zone's definitely automated requests are being blocked or challenged. - `sbfm_likely_automated?: string` Indicates that the zone's likely automated requests are being blocked or challenged. - `sbfm_static_resource_protection?: string` Indicates that the zone's static resource protection is turned on. - `sbfm_verified_bots?: string` Indicates that the zone's verified bot requests are being blocked. - `suppress_session_score?: boolean` Indicates that the zone's session score tracking is disabled. - `using_latest_model?: boolean` A read-only field that indicates whether the zone currently is running the latest ML model. - `SuperBotFightModeDefinitelyConfiguration` - `ai_bots_protection?: "block" | "disabled" | "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. - `"block"` - `"disabled"` - `"only_on_ad_pages"` - `cf_robots_variant?: "off" | "policy_only"` Specifies the Robots Access Control License variant to use. - `"off"` - `"policy_only"` - `crawler_protection?: "enabled" | "disabled"` Enable rule to punish AI Scrapers and Crawlers via a link maze. - `"enabled"` - `"disabled"` - `enable_js?: boolean` Use lightweight, invisible JavaScript detections to improve Bot Management. [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). - `is_robots_txt_managed?: 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?: boolean` Whether to optimize Super Bot Fight Mode protections for Wordpress. - `sbfm_definitely_automated?: "allow" | "block" | "managed_challenge"` Super Bot Fight Mode (SBFM) action to take on definitely automated requests. - `"allow"` - `"block"` - `"managed_challenge"` - `sbfm_static_resource_protection?: 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?: "allow" | "block"` Super Bot Fight Mode (SBFM) action to take on verified bots requests. - `"allow"` - `"block"` - `stale_zone_configuration?: StaleZoneConfiguration` 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?: boolean` Indicates that the zone's Bot Fight Mode is turned on. - `sbfm_likely_automated?: string` Indicates that the zone's likely automated requests are being blocked or challenged. - `using_latest_model?: boolean` A read-only field that indicates whether the zone currently is running the latest ML model. - `SuperBotFightModeLikelyConfiguration` - `ai_bots_protection?: "block" | "disabled" | "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. - `"block"` - `"disabled"` - `"only_on_ad_pages"` - `cf_robots_variant?: "off" | "policy_only"` Specifies the Robots Access Control License variant to use. - `"off"` - `"policy_only"` - `crawler_protection?: "enabled" | "disabled"` Enable rule to punish AI Scrapers and Crawlers via a link maze. - `"enabled"` - `"disabled"` - `enable_js?: boolean` Use lightweight, invisible JavaScript detections to improve Bot Management. [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). - `is_robots_txt_managed?: 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?: boolean` Whether to optimize Super Bot Fight Mode protections for Wordpress. - `sbfm_definitely_automated?: "allow" | "block" | "managed_challenge"` Super Bot Fight Mode (SBFM) action to take on definitely automated requests. - `"allow"` - `"block"` - `"managed_challenge"` - `sbfm_likely_automated?: "allow" | "block" | "managed_challenge"` Super Bot Fight Mode (SBFM) action to take on likely automated requests. - `"allow"` - `"block"` - `"managed_challenge"` - `sbfm_static_resource_protection?: 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?: "allow" | "block"` Super Bot Fight Mode (SBFM) action to take on verified bots requests. - `"allow"` - `"block"` - `stale_zone_configuration?: StaleZoneConfiguration` 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?: boolean` Indicates that the zone's Bot Fight Mode is turned on. - `using_latest_model?: boolean` A read-only field that indicates whether the zone currently is running the latest ML model. - `SubscriptionConfiguration` - `ai_bots_protection?: "block" | "disabled" | "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. - `"block"` - `"disabled"` - `"only_on_ad_pages"` - `auto_update_model?: boolean` Automatically update to the newest bot detection models created by Cloudflare as they are released. [Learn more.](https://developers.cloudflare.com/bots/reference/machine-learning-models#model-versions-and-release-notes) - `bm_cookie_enabled?: boolean` Indicates that the bot management cookie can be placed on end user devices accessing the site. Defaults to true - `cf_robots_variant?: "off" | "policy_only"` Specifies the Robots Access Control License variant to use. - `"off"` - `"policy_only"` - `crawler_protection?: "enabled" | "disabled"` Enable rule to punish AI Scrapers and Crawlers via a link maze. - `"enabled"` - `"disabled"` - `enable_js?: boolean` Use lightweight, invisible JavaScript detections to improve Bot Management. [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/). - `is_robots_txt_managed?: 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?: StaleZoneConfiguration` 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?: boolean` Indicates that the zone's Bot Fight Mode is turned on. - `optimize_wordpress?: boolean` Indicates that the zone's wordpress optimization for SBFM is turned on. - `sbfm_definitely_automated?: string` Indicates that the zone's definitely automated requests are being blocked or challenged. - `sbfm_likely_automated?: string` Indicates that the zone's likely automated requests are being blocked or challenged. - `sbfm_static_resource_protection?: string` Indicates that the zone's static resource protection is turned on. - `sbfm_verified_bots?: string` Indicates that the zone's verified bot requests are being blocked. - `suppress_session_score?: boolean` Whether to disable tracking the highest bot score for a session in the Bot Management cookie. - `using_latest_model?: boolean` A read-only field that indicates whether the zone currently is running the latest ML model. ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const botManagement = await client.botManagement.get({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353', }); console.log(botManagement); ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "ai_bots_protection": "block", "cf_robots_variant": "policy_only", "crawler_protection": "enabled", "enable_js": true, "fight_mode": true, "is_robots_txt_managed": false, "stale_zone_configuration": { "optimize_wordpress": true, "sbfm_definitely_automated": "sbfm_definitely_automated", "sbfm_likely_automated": "sbfm_likely_automated", "sbfm_static_resource_protection": "sbfm_static_resource_protection", "sbfm_verified_bots": "sbfm_verified_bots", "suppress_session_score": true }, "using_latest_model": true } } ```