getList

Cloudflare v6.13.0, Jan 21 26

Viewing docs for Cloudflare v6.13.0
published on Wednesday, Jan 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-cloudflare

Viewing docs for Cloudflare v6.13.0
published on Wednesday, Jan 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-cloudflare

Example Usage

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

const exampleList = cloudflare.getList({
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    listId: "2c0fc9fa937b11eaa1b71c4d701ab86e",
    search: "1.1.1.1",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_list = cloudflare.get_list(account_id="023e105f4ecef8ad9ca31a8372d0c353",
    list_id="2c0fc9fa937b11eaa1b71c4d701ab86e",
    search="1.1.1.1")

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.LookupList(ctx, &cloudflare.LookupListArgs{
			AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
			ListId:    "2c0fc9fa937b11eaa1b71c4d701ab86e",
			Search:    pulumi.StringRef("1.1.1.1"),
		}, 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 exampleList = Cloudflare.GetList.Invoke(new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        ListId = "2c0fc9fa937b11eaa1b71c4d701ab86e",
        Search = "1.1.1.1",
    });

});

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.GetListArgs;
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 exampleList = CloudflareFunctions.getList(GetListArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .listId("2c0fc9fa937b11eaa1b71c4d701ab86e")
            .search("1.1.1.1")
            .build());

    }
}

variables:
  exampleList:
    fn::invoke:
      function: cloudflare:getList
      arguments:
        accountId: 023e105f4ecef8ad9ca31a8372d0c353
        listId: 2c0fc9fa937b11eaa1b71c4d701ab86e
        search: 1.1.1.1

Using getList

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 getList(args: GetListArgs, opts?: InvokeOptions): Promise<GetListResult>
function getListOutput(args: GetListOutputArgs, opts?: InvokeOptions): Output<GetListResult>

def get_list(account_id: Optional[str] = None,
             list_id: Optional[str] = None,
             search: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetListResult
def get_list_output(account_id: Optional[pulumi.Input[str]] = None,
             list_id: Optional[pulumi.Input[str]] = None,
             search: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetListResult]

func LookupList(ctx *Context, args *LookupListArgs, opts ...InvokeOption) (*LookupListResult, error)
func LookupListOutput(ctx *Context, args *LookupListOutputArgs, opts ...InvokeOption) LookupListResultOutput

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

public static class GetList 
{
    public static Task<GetListResult> InvokeAsync(GetListArgs args, InvokeOptions? opts = null)
    public static Output<GetListResult> Invoke(GetListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetListResult> getList(GetListArgs args, InvokeOptions options)
public static Output<GetListResult> getList(GetListArgs args, InvokeOptions options)

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

The following arguments are supported:

AccountId string: The Account ID for this resource.
ListId string: The unique ID of the list.
Search string: A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.

AccountId string: The Account ID for this resource.
ListId string: The unique ID of the list.
Search string: A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.

accountId String: The Account ID for this resource.
listId String: The unique ID of the list.
search String: A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.

accountId string: The Account ID for this resource.
listId string: The unique ID of the list.
search string: A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.

account_id str: The Account ID for this resource.
list_id str: The unique ID of the list.
search str: A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.

accountId String: The Account ID for this resource.
listId String: The unique ID of the list.
search String: A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.

getList Result

The following output properties are available:

AccountId string: The Account ID for this resource.
CreatedOn string: The RFC 3339 timestamp of when the list was created.
Description string: An informative summary of the list.
Id string: The unique ID of the list.
Items List<GetListItem>: The items in the list. If set, this overwrites all items in the list. Do not use with cloudflare.ListItem.
Kind string: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). Available values: "ip", "redirect", "hostname", "asn".
ListId string: The unique ID of the list.
ModifiedOn string: The RFC 3339 timestamp of when the list was last modified.
Name string: An informative name for the list. Use this name in filter and rule expressions.
NumItems double: The number of items in the list.
NumReferencingFilters double: The number of filters referencing the list.
Search string: A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.

AccountId string: The Account ID for this resource.
CreatedOn string: The RFC 3339 timestamp of when the list was created.
Description string: An informative summary of the list.
Id string: The unique ID of the list.
Items []GetListItemType: The items in the list. If set, this overwrites all items in the list. Do not use with cloudflare.ListItem.
Kind string: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). Available values: "ip", "redirect", "hostname", "asn".
ListId string: The unique ID of the list.
ModifiedOn string: The RFC 3339 timestamp of when the list was last modified.
Name string: An informative name for the list. Use this name in filter and rule expressions.
NumItems float64: The number of items in the list.
NumReferencingFilters float64: The number of filters referencing the list.
Search string: A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.

accountId String: The Account ID for this resource.
createdOn String: The RFC 3339 timestamp of when the list was created.
description String: An informative summary of the list.
id String: The unique ID of the list.
items List<GetListItem>: The items in the list. If set, this overwrites all items in the list. Do not use with cloudflare.ListItem.
kind String: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). Available values: "ip", "redirect", "hostname", "asn".
listId String: The unique ID of the list.
modifiedOn String: The RFC 3339 timestamp of when the list was last modified.
name String: An informative name for the list. Use this name in filter and rule expressions.
numItems Double: The number of items in the list.
numReferencingFilters Double: The number of filters referencing the list.
search String: A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.

accountId string: The Account ID for this resource.
createdOn string: The RFC 3339 timestamp of when the list was created.
description string: An informative summary of the list.
id string: The unique ID of the list.
items GetListItem[]: The items in the list. If set, this overwrites all items in the list. Do not use with cloudflare.ListItem.
kind string: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). Available values: "ip", "redirect", "hostname", "asn".
listId string: The unique ID of the list.
modifiedOn string: The RFC 3339 timestamp of when the list was last modified.
name string: An informative name for the list. Use this name in filter and rule expressions.
numItems number: The number of items in the list.
numReferencingFilters number: The number of filters referencing the list.
search string: A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.

account_id str: The Account ID for this resource.
created_on str: The RFC 3339 timestamp of when the list was created.
description str: An informative summary of the list.
id str: The unique ID of the list.
items Sequence[GetListItem]: The items in the list. If set, this overwrites all items in the list. Do not use with cloudflare.ListItem.
kind str: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). Available values: "ip", "redirect", "hostname", "asn".
list_id str: The unique ID of the list.
modified_on str: The RFC 3339 timestamp of when the list was last modified.
name str: An informative name for the list. Use this name in filter and rule expressions.
num_items float: The number of items in the list.
num_referencing_filters float: The number of filters referencing the list.
search str: A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.

accountId String: The Account ID for this resource.
createdOn String: The RFC 3339 timestamp of when the list was created.
description String: An informative summary of the list.
id String: The unique ID of the list.
items List<Property Map>: The items in the list. If set, this overwrites all items in the list. Do not use with cloudflare.ListItem.
kind String: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). Available values: "ip", "redirect", "hostname", "asn".
listId String: The unique ID of the list.
modifiedOn String: The RFC 3339 timestamp of when the list was last modified.
name String: An informative name for the list. Use this name in filter and rule expressions.
numItems Number: The number of items in the list.
numReferencingFilters Number: The number of filters referencing the list.
search String: A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.

Supporting Types

GetListItem

Asn int: A non-negative 32 bit integer
Comment string: An informative summary of the list item.
Hostname GetListItemHostname: Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
Ip string: An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
Redirect GetListItemRedirect: The definition of the redirect.

Asn int: A non-negative 32 bit integer
Comment string: An informative summary of the list item.
Hostname GetListItemHostname: Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
Ip string: An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
Redirect GetListItemRedirect: The definition of the redirect.

asn Integer: A non-negative 32 bit integer
comment String: An informative summary of the list item.
hostname GetListItemHostname: Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
ip String: An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
redirect GetListItemRedirect: The definition of the redirect.

asn number: A non-negative 32 bit integer
comment string: An informative summary of the list item.
hostname GetListItemHostname: Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
ip string: An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
redirect GetListItemRedirect: The definition of the redirect.

asn int: A non-negative 32 bit integer
comment str: An informative summary of the list item.
hostname GetListItemHostname: Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
ip str: An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
redirect GetListItemRedirect: The definition of the redirect.

asn Number: A non-negative 32 bit integer
comment String: An informative summary of the list item.
hostname Property Map: Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
ip String: An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
redirect Property Map: The definition of the redirect.

GetListItemHostname

ExcludeExactHostname bool: Only applies to wildcard hostnames (e.g., *.example.com). When true (default), only subdomains are blocked. When false, both the root domain and subdomains are blocked.
UrlHostname string

ExcludeExactHostname bool: Only applies to wildcard hostnames (e.g., *.example.com). When true (default), only subdomains are blocked. When false, both the root domain and subdomains are blocked.
UrlHostname string

excludeExactHostname Boolean: Only applies to wildcard hostnames (e.g., *.example.com). When true (default), only subdomains are blocked. When false, both the root domain and subdomains are blocked.
urlHostname String

excludeExactHostname boolean: Only applies to wildcard hostnames (e.g., *.example.com). When true (default), only subdomains are blocked. When false, both the root domain and subdomains are blocked.
urlHostname string

exclude_exact_hostname bool: Only applies to wildcard hostnames (e.g., *.example.com). When true (default), only subdomains are blocked. When false, both the root domain and subdomains are blocked.
url_hostname str

excludeExactHostname Boolean: Only applies to wildcard hostnames (e.g., *.example.com). When true (default), only subdomains are blocked. When false, both the root domain and subdomains are blocked.
urlHostname String