Update Zone Bot Management Config
Updates the Bot Management configuration for a zone.
This API is used to update:
- Bot Fight Mode
- Super Bot Fight Mode
- Bot Management for Enterprise
See Bot Plans for more information on the different plans
If you recently upgraded or downgraded your plan, refer to the following examples to clean up old configurations.
Copy and paste the example body to remove old zone configurations based on your current plan.
Clean up configuration for Bot Fight Mode plan
{
"sbfm_likely_automated": "allow",
"sbfm_definitely_automated": "allow",
"sbfm_verified_bots": "allow",
"sbfm_static_resource_protection": false,
"optimize_wordpress": false,
"suppress_session_score": false
}Clean up configuration for SBFM Pro plan
{
"sbfm_likely_automated": "allow",
"fight_mode": false
}Clean up configuration for SBFM Biz plan
{
"fight_mode": false
}Clean up configuration for BM Enterprise Subscription plan
It is strongly recommended that you ensure you have custom rules in place to protect your zone before disabling the SBFM rules. Without these protections, your zone is vulnerable to attacks.
{
"sbfm_likely_automated": "allow",
"sbfm_definitely_automated": "allow",
"sbfm_verified_bots": "allow",
"sbfm_static_resource_protection": false,
"optimize_wordpress": false,
"fight_mode": false
}Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Accepted Permissions (at least one required)
Update Zone Bot Management Config
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.update({
zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
ai_bots_protection: 'disabled',
cf_robots_variant: 'off',
crawler_protection: 'disabled',
enable_js: true,
fight_mode: true,
});
console.log(botManagement);{
"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
}
}Returns Examples
{
"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
}
}