1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getBotManagement
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.getBotManagement

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleBotManagement = cloudflare.getBotManagement({
        zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_bot_management = cloudflare.get_bot_management(zone_id="023e105f4ecef8ad9ca31a8372d0c353")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.LookupBotManagement(ctx, &cloudflare.LookupBotManagementArgs{
    			ZoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleBotManagement = Cloudflare.GetBotManagement.Invoke(new()
        {
            ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.CloudflareFunctions;
    import com.pulumi.cloudflare.inputs.GetBotManagementArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var exampleBotManagement = CloudflareFunctions.getBotManagement(GetBotManagementArgs.builder()
                .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
                .build());
    
        }
    }
    
    variables:
      exampleBotManagement:
        fn::invoke:
          function: cloudflare:getBotManagement
          arguments:
            zoneId: 023e105f4ecef8ad9ca31a8372d0c353
    

    Using getBotManagement

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBotManagement(args: GetBotManagementArgs, opts?: InvokeOptions): Promise<GetBotManagementResult>
    function getBotManagementOutput(args: GetBotManagementOutputArgs, opts?: InvokeOptions): Output<GetBotManagementResult>
    def get_bot_management(zone_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetBotManagementResult
    def get_bot_management_output(zone_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetBotManagementResult]
    func LookupBotManagement(ctx *Context, args *LookupBotManagementArgs, opts ...InvokeOption) (*LookupBotManagementResult, error)
    func LookupBotManagementOutput(ctx *Context, args *LookupBotManagementOutputArgs, opts ...InvokeOption) LookupBotManagementResultOutput

    > Note: This function is named LookupBotManagement in the Go SDK.

    public static class GetBotManagement 
    {
        public static Task<GetBotManagementResult> InvokeAsync(GetBotManagementArgs args, InvokeOptions? opts = null)
        public static Output<GetBotManagementResult> Invoke(GetBotManagementInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBotManagementResult> getBotManagement(GetBotManagementArgs args, InvokeOptions options)
    public static Output<GetBotManagementResult> getBotManagement(GetBotManagementArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudflare:index/getBotManagement:getBotManagement
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ZoneId string
    Identifier
    ZoneId string
    Identifier
    zoneId String
    Identifier
    zoneId string
    Identifier
    zone_id str
    Identifier
    zoneId String
    Identifier

    getBotManagement Result

    The following output properties are available:

    AiBotsProtection string
    Enable rule to block AI Scrapers and Crawlers. Available values: "block", "disabled".
    AutoUpdateModel bool
    Automatically update to the newest bot detection models created by Cloudflare as they are released. Learn more.
    CrawlerProtection string
    Enable rule to punish AI Scrapers and Crawlers via a link maze. Available values: "enabled", "disabled".
    EnableJs bool
    Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.
    FightMode bool
    Whether to enable Bot Fight Mode.
    Id string
    The provider-assigned unique ID for this managed resource.
    OptimizeWordpress bool
    Whether to optimize Super Bot Fight Mode protections for Wordpress.
    SbfmDefinitelyAutomated string
    Super Bot Fight Mode (SBFM) action to take on definitely automated requests. Available values: "allow", "block", "managed_challenge".
    SbfmLikelyAutomated string
    Super Bot Fight Mode (SBFM) action to take on likely automated requests. Available values: "allow", "block", "managed_challenge".
    SbfmStaticResourceProtection bool
    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.
    SbfmVerifiedBots string
    Super Bot Fight Mode (SBFM) action to take on verified bots requests. Available values: "allow", "block".
    StaleZoneConfiguration GetBotManagementStaleZoneConfiguration
    A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.
    SuppressSessionScore bool
    Whether to disable tracking the highest bot score for a session in the Bot Management cookie.
    UsingLatestModel bool
    A read-only field that indicates whether the zone currently is running the latest ML model.
    ZoneId string
    Identifier
    AiBotsProtection string
    Enable rule to block AI Scrapers and Crawlers. Available values: "block", "disabled".
    AutoUpdateModel bool
    Automatically update to the newest bot detection models created by Cloudflare as they are released. Learn more.
    CrawlerProtection string
    Enable rule to punish AI Scrapers and Crawlers via a link maze. Available values: "enabled", "disabled".
    EnableJs bool
    Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.
    FightMode bool
    Whether to enable Bot Fight Mode.
    Id string
    The provider-assigned unique ID for this managed resource.
    OptimizeWordpress bool
    Whether to optimize Super Bot Fight Mode protections for Wordpress.
    SbfmDefinitelyAutomated string
    Super Bot Fight Mode (SBFM) action to take on definitely automated requests. Available values: "allow", "block", "managed_challenge".
    SbfmLikelyAutomated string
    Super Bot Fight Mode (SBFM) action to take on likely automated requests. Available values: "allow", "block", "managed_challenge".
    SbfmStaticResourceProtection bool
    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.
    SbfmVerifiedBots string
    Super Bot Fight Mode (SBFM) action to take on verified bots requests. Available values: "allow", "block".
    StaleZoneConfiguration GetBotManagementStaleZoneConfiguration
    A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.
    SuppressSessionScore bool
    Whether to disable tracking the highest bot score for a session in the Bot Management cookie.
    UsingLatestModel bool
    A read-only field that indicates whether the zone currently is running the latest ML model.
    ZoneId string
    Identifier
    aiBotsProtection String
    Enable rule to block AI Scrapers and Crawlers. Available values: "block", "disabled".
    autoUpdateModel Boolean
    Automatically update to the newest bot detection models created by Cloudflare as they are released. Learn more.
    crawlerProtection String
    Enable rule to punish AI Scrapers and Crawlers via a link maze. Available values: "enabled", "disabled".
    enableJs Boolean
    Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.
    fightMode Boolean
    Whether to enable Bot Fight Mode.
    id String
    The provider-assigned unique ID for this managed resource.
    optimizeWordpress Boolean
    Whether to optimize Super Bot Fight Mode protections for Wordpress.
    sbfmDefinitelyAutomated String
    Super Bot Fight Mode (SBFM) action to take on definitely automated requests. Available values: "allow", "block", "managed_challenge".
    sbfmLikelyAutomated String
    Super Bot Fight Mode (SBFM) action to take on likely automated requests. Available values: "allow", "block", "managed_challenge".
    sbfmStaticResourceProtection 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.
    sbfmVerifiedBots String
    Super Bot Fight Mode (SBFM) action to take on verified bots requests. Available values: "allow", "block".
    staleZoneConfiguration GetBotManagementStaleZoneConfiguration
    A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.
    suppressSessionScore Boolean
    Whether to disable tracking the highest bot score for a session in the Bot Management cookie.
    usingLatestModel Boolean
    A read-only field that indicates whether the zone currently is running the latest ML model.
    zoneId String
    Identifier
    aiBotsProtection string
    Enable rule to block AI Scrapers and Crawlers. Available values: "block", "disabled".
    autoUpdateModel boolean
    Automatically update to the newest bot detection models created by Cloudflare as they are released. Learn more.
    crawlerProtection string
    Enable rule to punish AI Scrapers and Crawlers via a link maze. Available values: "enabled", "disabled".
    enableJs boolean
    Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.
    fightMode boolean
    Whether to enable Bot Fight Mode.
    id string
    The provider-assigned unique ID for this managed resource.
    optimizeWordpress boolean
    Whether to optimize Super Bot Fight Mode protections for Wordpress.
    sbfmDefinitelyAutomated string
    Super Bot Fight Mode (SBFM) action to take on definitely automated requests. Available values: "allow", "block", "managed_challenge".
    sbfmLikelyAutomated string
    Super Bot Fight Mode (SBFM) action to take on likely automated requests. Available values: "allow", "block", "managed_challenge".
    sbfmStaticResourceProtection 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.
    sbfmVerifiedBots string
    Super Bot Fight Mode (SBFM) action to take on verified bots requests. Available values: "allow", "block".
    staleZoneConfiguration GetBotManagementStaleZoneConfiguration
    A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.
    suppressSessionScore boolean
    Whether to disable tracking the highest bot score for a session in the Bot Management cookie.
    usingLatestModel boolean
    A read-only field that indicates whether the zone currently is running the latest ML model.
    zoneId string
    Identifier
    ai_bots_protection str
    Enable rule to block AI Scrapers and Crawlers. Available values: "block", "disabled".
    auto_update_model bool
    Automatically update to the newest bot detection models created by Cloudflare as they are released. Learn more.
    crawler_protection str
    Enable rule to punish AI Scrapers and Crawlers via a link maze. Available values: "enabled", "disabled".
    enable_js bool
    Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.
    fight_mode bool
    Whether to enable Bot Fight Mode.
    id str
    The provider-assigned unique ID for this managed resource.
    optimize_wordpress bool
    Whether to optimize Super Bot Fight Mode protections for Wordpress.
    sbfm_definitely_automated str
    Super Bot Fight Mode (SBFM) action to take on definitely automated requests. Available values: "allow", "block", "managed_challenge".
    sbfm_likely_automated str
    Super Bot Fight Mode (SBFM) action to take on likely automated requests. Available values: "allow", "block", "managed_challenge".
    sbfm_static_resource_protection bool
    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 str
    Super Bot Fight Mode (SBFM) action to take on verified bots requests. Available values: "allow", "block".
    stale_zone_configuration GetBotManagementStaleZoneConfiguration
    A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.
    suppress_session_score bool
    Whether to disable tracking the highest bot score for a session in the Bot Management cookie.
    using_latest_model bool
    A read-only field that indicates whether the zone currently is running the latest ML model.
    zone_id str
    Identifier
    aiBotsProtection String
    Enable rule to block AI Scrapers and Crawlers. Available values: "block", "disabled".
    autoUpdateModel Boolean
    Automatically update to the newest bot detection models created by Cloudflare as they are released. Learn more.
    crawlerProtection String
    Enable rule to punish AI Scrapers and Crawlers via a link maze. Available values: "enabled", "disabled".
    enableJs Boolean
    Use lightweight, invisible JavaScript detections to improve Bot Management. Learn more about JavaScript Detections.
    fightMode Boolean
    Whether to enable Bot Fight Mode.
    id String
    The provider-assigned unique ID for this managed resource.
    optimizeWordpress Boolean
    Whether to optimize Super Bot Fight Mode protections for Wordpress.
    sbfmDefinitelyAutomated String
    Super Bot Fight Mode (SBFM) action to take on definitely automated requests. Available values: "allow", "block", "managed_challenge".
    sbfmLikelyAutomated String
    Super Bot Fight Mode (SBFM) action to take on likely automated requests. Available values: "allow", "block", "managed_challenge".
    sbfmStaticResourceProtection 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.
    sbfmVerifiedBots String
    Super Bot Fight Mode (SBFM) action to take on verified bots requests. Available values: "allow", "block".
    staleZoneConfiguration Property Map
    A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.
    suppressSessionScore Boolean
    Whether to disable tracking the highest bot score for a session in the Bot Management cookie.
    usingLatestModel Boolean
    A read-only field that indicates whether the zone currently is running the latest ML model.
    zoneId String
    Identifier

    Supporting Types

    GetBotManagementStaleZoneConfiguration

    FightMode bool
    Indicates that the zone's Bot Fight Mode is turned on.
    OptimizeWordpress bool
    Indicates that the zone's wordpress optimization for SBFM is turned on.
    SbfmDefinitelyAutomated string
    Indicates that the zone's definitely automated requests are being blocked or challenged.
    SbfmLikelyAutomated string
    Indicates that the zone's likely automated requests are being blocked or challenged.
    SbfmStaticResourceProtection string
    Indicates that the zone's static resource protection is turned on.
    SbfmVerifiedBots string
    Indicates that the zone's verified bot requests are being blocked.
    SuppressSessionScore bool
    Indicates that the zone's session score tracking is disabled.
    FightMode bool
    Indicates that the zone's Bot Fight Mode is turned on.
    OptimizeWordpress bool
    Indicates that the zone's wordpress optimization for SBFM is turned on.
    SbfmDefinitelyAutomated string
    Indicates that the zone's definitely automated requests are being blocked or challenged.
    SbfmLikelyAutomated string
    Indicates that the zone's likely automated requests are being blocked or challenged.
    SbfmStaticResourceProtection string
    Indicates that the zone's static resource protection is turned on.
    SbfmVerifiedBots string
    Indicates that the zone's verified bot requests are being blocked.
    SuppressSessionScore bool
    Indicates that the zone's session score tracking is disabled.
    fightMode Boolean
    Indicates that the zone's Bot Fight Mode is turned on.
    optimizeWordpress Boolean
    Indicates that the zone's wordpress optimization for SBFM is turned on.
    sbfmDefinitelyAutomated String
    Indicates that the zone's definitely automated requests are being blocked or challenged.
    sbfmLikelyAutomated String
    Indicates that the zone's likely automated requests are being blocked or challenged.
    sbfmStaticResourceProtection String
    Indicates that the zone's static resource protection is turned on.
    sbfmVerifiedBots String
    Indicates that the zone's verified bot requests are being blocked.
    suppressSessionScore Boolean
    Indicates that the zone's session score tracking is disabled.
    fightMode boolean
    Indicates that the zone's Bot Fight Mode is turned on.
    optimizeWordpress boolean
    Indicates that the zone's wordpress optimization for SBFM is turned on.
    sbfmDefinitelyAutomated string
    Indicates that the zone's definitely automated requests are being blocked or challenged.
    sbfmLikelyAutomated string
    Indicates that the zone's likely automated requests are being blocked or challenged.
    sbfmStaticResourceProtection string
    Indicates that the zone's static resource protection is turned on.
    sbfmVerifiedBots string
    Indicates that the zone's verified bot requests are being blocked.
    suppressSessionScore boolean
    Indicates that the zone's session score tracking is disabled.
    fight_mode bool
    Indicates that the zone's Bot Fight Mode is turned on.
    optimize_wordpress bool
    Indicates that the zone's wordpress optimization for SBFM is turned on.
    sbfm_definitely_automated str
    Indicates that the zone's definitely automated requests are being blocked or challenged.
    sbfm_likely_automated str
    Indicates that the zone's likely automated requests are being blocked or challenged.
    sbfm_static_resource_protection str
    Indicates that the zone's static resource protection is turned on.
    sbfm_verified_bots str
    Indicates that the zone's verified bot requests are being blocked.
    suppress_session_score bool
    Indicates that the zone's session score tracking is disabled.
    fightMode Boolean
    Indicates that the zone's Bot Fight Mode is turned on.
    optimizeWordpress Boolean
    Indicates that the zone's wordpress optimization for SBFM is turned on.
    sbfmDefinitelyAutomated String
    Indicates that the zone's definitely automated requests are being blocked or challenged.
    sbfmLikelyAutomated String
    Indicates that the zone's likely automated requests are being blocked or challenged.
    sbfmStaticResourceProtection String
    Indicates that the zone's static resource protection is turned on.
    sbfmVerifiedBots String
    Indicates that the zone's verified bot requests are being blocked.
    suppressSessionScore Boolean
    Indicates that the zone's session score tracking is disabled.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi