1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getZoneLockdown
Viewing docs for Cloudflare v6.13.1
published on Monday, Mar 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

cloudflare.getZoneLockdown

logo
Viewing docs for Cloudflare v6.13.1
published on Monday, Mar 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleZoneLockdown = cloudflare.getZoneLockdown({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    lockDownsId: "372e67954025e0ba6aaa6d586b9e0b59",
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_zone_lockdown = cloudflare.get_zone_lockdown(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    lock_downs_id="372e67954025e0ba6aaa6d586b9e0b59")

    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.LookupZoneLockdown(ctx, &cloudflare.LookupZoneLockdownArgs{
			ZoneId:      "023e105f4ecef8ad9ca31a8372d0c353",
			LockDownsId: pulumi.StringRef("372e67954025e0ba6aaa6d586b9e0b59"),
		}, 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 exampleZoneLockdown = Cloudflare.GetZoneLockdown.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        LockDownsId = "372e67954025e0ba6aaa6d586b9e0b59",
    });

});

    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.GetZoneLockdownArgs;
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 exampleZoneLockdown = CloudflareFunctions.getZoneLockdown(GetZoneLockdownArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .lockDownsId("372e67954025e0ba6aaa6d586b9e0b59")
            .build());

    }
}

    variables:
  exampleZoneLockdown:
    fn::invoke:
      function: cloudflare:getZoneLockdown
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        lockDownsId: 372e67954025e0ba6aaa6d586b9e0b59

    Using getZoneLockdown

    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 getZoneLockdown(args: GetZoneLockdownArgs, opts?: InvokeOptions): Promise<GetZoneLockdownResult>
function getZoneLockdownOutput(args: GetZoneLockdownOutputArgs, opts?: InvokeOptions): Output<GetZoneLockdownResult>
    def get_zone_lockdown(filter: Optional[GetZoneLockdownFilter] = None,
                      lock_downs_id: Optional[str] = None,
                      zone_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetZoneLockdownResult
def get_zone_lockdown_output(filter: Optional[pulumi.Input[GetZoneLockdownFilterArgs]] = None,
                      lock_downs_id: Optional[pulumi.Input[str]] = None,
                      zone_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetZoneLockdownResult]
    func LookupZoneLockdown(ctx *Context, args *LookupZoneLockdownArgs, opts ...InvokeOption) (*LookupZoneLockdownResult, error)
func LookupZoneLockdownOutput(ctx *Context, args *LookupZoneLockdownOutputArgs, opts ...InvokeOption) LookupZoneLockdownResultOutput

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

    public static class GetZoneLockdown 
{
    public static Task<GetZoneLockdownResult> InvokeAsync(GetZoneLockdownArgs args, InvokeOptions? opts = null)
    public static Output<GetZoneLockdownResult> Invoke(GetZoneLockdownInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetZoneLockdownResult> getZoneLockdown(GetZoneLockdownArgs args, InvokeOptions options)
public static Output<GetZoneLockdownResult> getZoneLockdown(GetZoneLockdownArgs args, InvokeOptions options)

    fn::invoke:
  function: cloudflare:index/getZoneLockdown:getZoneLockdown
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ZoneId string
    Defines an identifier.
    Filter GetZoneLockdownFilter
    LockDownsId string
    The unique identifier of the Zone Lockdown rule.
    ZoneId string
    Defines an identifier.
    Filter GetZoneLockdownFilter
    LockDownsId string
    The unique identifier of the Zone Lockdown rule.
    zoneId String
    Defines an identifier.
    filter GetZoneLockdownFilter
    lockDownsId String
    The unique identifier of the Zone Lockdown rule.
    zoneId string
    Defines an identifier.
    filter GetZoneLockdownFilter
    lockDownsId string
    The unique identifier of the Zone Lockdown rule.
    zone_id str
    Defines an identifier.
    filter GetZoneLockdownFilter
    lock_downs_id str
    The unique identifier of the Zone Lockdown rule.
    zoneId String
    Defines an identifier.
    filter Property Map
    lockDownsId String
    The unique identifier of the Zone Lockdown rule.

    getZoneLockdown Result

    The following output properties are available:

    Configurations List<GetZoneLockdownConfiguration>
    A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of ip or ipRange configurations.
    CreatedOn string
    The timestamp of when the rule was created.
    Description string
    An informative summary of the rule.
    Id string
    The unique identifier of the Zone Lockdown rule.
    ModifiedOn string
    The timestamp of when the rule was last modified.
    Paused bool
    When true, indicates that the rule is currently paused.
    Urls List<string>
    The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.
    ZoneId string
    Defines an identifier.
    Filter GetZoneLockdownFilter
    LockDownsId string
    The unique identifier of the Zone Lockdown rule.
    Configurations []GetZoneLockdownConfiguration
    A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of ip or ipRange configurations.
    CreatedOn string
    The timestamp of when the rule was created.
    Description string
    An informative summary of the rule.
    Id string
    The unique identifier of the Zone Lockdown rule.
    ModifiedOn string
    The timestamp of when the rule was last modified.
    Paused bool
    When true, indicates that the rule is currently paused.
    Urls []string
    The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.
    ZoneId string
    Defines an identifier.
    Filter GetZoneLockdownFilter
    LockDownsId string
    The unique identifier of the Zone Lockdown rule.
    configurations List<GetZoneLockdownConfiguration>
    A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of ip or ipRange configurations.
    createdOn String
    The timestamp of when the rule was created.
    description String
    An informative summary of the rule.
    id String
    The unique identifier of the Zone Lockdown rule.
    modifiedOn String
    The timestamp of when the rule was last modified.
    paused Boolean
    When true, indicates that the rule is currently paused.
    urls List<String>
    The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.
    zoneId String
    Defines an identifier.
    filter GetZoneLockdownFilter
    lockDownsId String
    The unique identifier of the Zone Lockdown rule.
    configurations GetZoneLockdownConfiguration[]
    A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of ip or ipRange configurations.
    createdOn string
    The timestamp of when the rule was created.
    description string
    An informative summary of the rule.
    id string
    The unique identifier of the Zone Lockdown rule.
    modifiedOn string
    The timestamp of when the rule was last modified.
    paused boolean
    When true, indicates that the rule is currently paused.
    urls string[]
    The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.
    zoneId string
    Defines an identifier.
    filter GetZoneLockdownFilter
    lockDownsId string
    The unique identifier of the Zone Lockdown rule.
    configurations Sequence[GetZoneLockdownConfiguration]
    A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of ip or ipRange configurations.
    created_on str
    The timestamp of when the rule was created.
    description str
    An informative summary of the rule.
    id str
    The unique identifier of the Zone Lockdown rule.
    modified_on str
    The timestamp of when the rule was last modified.
    paused bool
    When true, indicates that the rule is currently paused.
    urls Sequence[str]
    The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.
    zone_id str
    Defines an identifier.
    filter GetZoneLockdownFilter
    lock_downs_id str
    The unique identifier of the Zone Lockdown rule.
    configurations List<Property Map>
    A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of ip or ipRange configurations.
    createdOn String
    The timestamp of when the rule was created.
    description String
    An informative summary of the rule.
    id String
    The unique identifier of the Zone Lockdown rule.
    modifiedOn String
    The timestamp of when the rule was last modified.
    paused Boolean
    When true, indicates that the rule is currently paused.
    urls List<String>
    The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.
    zoneId String
    Defines an identifier.
    filter Property Map
    lockDownsId String
    The unique identifier of the Zone Lockdown rule.

    Supporting Types

    GetZoneLockdownConfiguration

    Target string
    The configuration target. You must set the target to ip when specifying an IP address in the Zone Lockdown rule. Available values: "ip", "ipRange".
    Value string
    The IP address to match. This address will be compared to the IP address of incoming requests.
    Target string
    The configuration target. You must set the target to ip when specifying an IP address in the Zone Lockdown rule. Available values: "ip", "ipRange".
    Value string
    The IP address to match. This address will be compared to the IP address of incoming requests.
    target String
    The configuration target. You must set the target to ip when specifying an IP address in the Zone Lockdown rule. Available values: "ip", "ipRange".
    value String
    The IP address to match. This address will be compared to the IP address of incoming requests.
    target string
    The configuration target. You must set the target to ip when specifying an IP address in the Zone Lockdown rule. Available values: "ip", "ipRange".
    value string
    The IP address to match. This address will be compared to the IP address of incoming requests.
    target str
    The configuration target. You must set the target to ip when specifying an IP address in the Zone Lockdown rule. Available values: "ip", "ipRange".
    value str
    The IP address to match. This address will be compared to the IP address of incoming requests.
    target String
    The configuration target. You must set the target to ip when specifying an IP address in the Zone Lockdown rule. Available values: "ip", "ipRange".
    value String
    The IP address to match. This address will be compared to the IP address of incoming requests.

    GetZoneLockdownFilter

    CreatedOn string
    The timestamp of when the rule was created.
    Description string
    A string to search for in the description of existing rules.
    DescriptionSearch string
    A string to search for in the description of existing rules.
    Ip string
    A single IP address to search for in existing rules.
    IpRangeSearch string
    A single IP address range to search for in existing rules.
    IpSearch string
    A single IP address to search for in existing rules.
    ModifiedOn string
    The timestamp of when the rule was last modified.
    Priority double
    The priority of the rule to control the processing order. A lower number indicates higher priority. If not provided, any rules with a configured priority will be processed before rules without a priority.
    UriSearch string
    A single URI to search for in the list of URLs of existing rules.
    CreatedOn string
    The timestamp of when the rule was created.
    Description string
    A string to search for in the description of existing rules.
    DescriptionSearch string
    A string to search for in the description of existing rules.
    Ip string
    A single IP address to search for in existing rules.
    IpRangeSearch string
    A single IP address range to search for in existing rules.
    IpSearch string
    A single IP address to search for in existing rules.
    ModifiedOn string
    The timestamp of when the rule was last modified.
    Priority float64
    The priority of the rule to control the processing order. A lower number indicates higher priority. If not provided, any rules with a configured priority will be processed before rules without a priority.
    UriSearch string
    A single URI to search for in the list of URLs of existing rules.
    createdOn String
    The timestamp of when the rule was created.
    description String
    A string to search for in the description of existing rules.
    descriptionSearch String
    A string to search for in the description of existing rules.
    ip String
    A single IP address to search for in existing rules.
    ipRangeSearch String
    A single IP address range to search for in existing rules.
    ipSearch String
    A single IP address to search for in existing rules.
    modifiedOn String
    The timestamp of when the rule was last modified.
    priority Double
    The priority of the rule to control the processing order. A lower number indicates higher priority. If not provided, any rules with a configured priority will be processed before rules without a priority.
    uriSearch String
    A single URI to search for in the list of URLs of existing rules.
    createdOn string
    The timestamp of when the rule was created.
    description string
    A string to search for in the description of existing rules.
    descriptionSearch string
    A string to search for in the description of existing rules.
    ip string
    A single IP address to search for in existing rules.
    ipRangeSearch string
    A single IP address range to search for in existing rules.
    ipSearch string
    A single IP address to search for in existing rules.
    modifiedOn string
    The timestamp of when the rule was last modified.
    priority number
    The priority of the rule to control the processing order. A lower number indicates higher priority. If not provided, any rules with a configured priority will be processed before rules without a priority.
    uriSearch string
    A single URI to search for in the list of URLs of existing rules.
    created_on str
    The timestamp of when the rule was created.
    description str
    A string to search for in the description of existing rules.
    description_search str
    A string to search for in the description of existing rules.
    ip str
    A single IP address to search for in existing rules.
    ip_range_search str
    A single IP address range to search for in existing rules.
    ip_search str
    A single IP address to search for in existing rules.
    modified_on str
    The timestamp of when the rule was last modified.
    priority float
    The priority of the rule to control the processing order. A lower number indicates higher priority. If not provided, any rules with a configured priority will be processed before rules without a priority.
    uri_search str
    A single URI to search for in the list of URLs of existing rules.
    createdOn String
    The timestamp of when the rule was created.
    description String
    A string to search for in the description of existing rules.
    descriptionSearch String
    A string to search for in the description of existing rules.
    ip String
    A single IP address to search for in existing rules.
    ipRangeSearch String
    A single IP address range to search for in existing rules.
    ipSearch String
    A single IP address to search for in existing rules.
    modifiedOn String
    The timestamp of when the rule was last modified.
    priority Number
    The priority of the rule to control the processing order. A lower number indicates higher priority. If not provided, any rules with a configured priority will be processed before rules without a priority.
    uriSearch String
    A single URI to search for in the list of URLs of existing rules.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    logo
    Viewing docs for Cloudflare v6.13.1
    published on Monday, Mar 30, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-cloudflare
      Try Pulumi Cloud free. Your team will thank you.