getListItem

Cloudflare v6.14.0, Apr 2 26

Viewing docs for Cloudflare v6.14.0
published on Thursday, Apr 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-cloudflare

Viewing docs for Cloudflare v6.14.0
published on Thursday, Apr 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-cloudflare

Example Usage

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

const exampleListItem = cloudflare.getListItem({
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    listId: "2c0fc9fa937b11eaa1b71c4d701ab86e",
    itemId: "34b12448945f11eaa1b71c4d701ab86e",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_list_item = cloudflare.get_list_item(account_id="023e105f4ecef8ad9ca31a8372d0c353",
    list_id="2c0fc9fa937b11eaa1b71c4d701ab86e",
    item_id="34b12448945f11eaa1b71c4d701ab86e")

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.LookupListItem(ctx, &cloudflare.LookupListItemArgs{
			AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
			ListId:    "2c0fc9fa937b11eaa1b71c4d701ab86e",
			ItemId:    "34b12448945f11eaa1b71c4d701ab86e",
		}, 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 exampleListItem = Cloudflare.GetListItem.Invoke(new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        ListId = "2c0fc9fa937b11eaa1b71c4d701ab86e",
        ItemId = "34b12448945f11eaa1b71c4d701ab86e",
    });

});

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.GetListItemArgs;
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 exampleListItem = CloudflareFunctions.getListItem(GetListItemArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .listId("2c0fc9fa937b11eaa1b71c4d701ab86e")
            .itemId("34b12448945f11eaa1b71c4d701ab86e")
            .build());

    }
}

variables:
  exampleListItem:
    fn::invoke:
      function: cloudflare:getListItem
      arguments:
        accountId: 023e105f4ecef8ad9ca31a8372d0c353
        listId: 2c0fc9fa937b11eaa1b71c4d701ab86e
        itemId: 34b12448945f11eaa1b71c4d701ab86e

Using getListItem

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 getListItem(args: GetListItemArgs, opts?: InvokeOptions): Promise<GetListItemResult>
function getListItemOutput(args: GetListItemOutputArgs, opts?: InvokeOptions): Output<GetListItemResult>

def get_list_item(account_id: Optional[str] = None,
                  item_id: Optional[str] = None,
                  list_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetListItemResult
def get_list_item_output(account_id: Optional[pulumi.Input[str]] = None,
                  item_id: Optional[pulumi.Input[str]] = None,
                  list_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetListItemResult]

func LookupListItem(ctx *Context, args *LookupListItemArgs, opts ...InvokeOption) (*LookupListItemResult, error)
func LookupListItemOutput(ctx *Context, args *LookupListItemOutputArgs, opts ...InvokeOption) LookupListItemResultOutput

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

public static class GetListItem 
{
    public static Task<GetListItemResult> InvokeAsync(GetListItemArgs args, InvokeOptions? opts = null)
    public static Output<GetListItemResult> Invoke(GetListItemInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetListItemResult> getListItem(GetListItemArgs args, InvokeOptions options)
public static Output<GetListItemResult> getListItem(GetListItemArgs args, InvokeOptions options)

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

The following arguments are supported:

AccountId string: The Account ID for this resource.
ItemId string: Defines the unique ID of the item in the List.
ListId string: The unique ID of the list.

AccountId string: The Account ID for this resource.
ItemId string: Defines the unique ID of the item in the List.
ListId string: The unique ID of the list.

accountId String: The Account ID for this resource.
itemId String: Defines the unique ID of the item in the List.
listId String: The unique ID of the list.

accountId string: The Account ID for this resource.
itemId string: Defines the unique ID of the item in the List.
listId string: The unique ID of the list.

account_id str: The Account ID for this resource.
item_id str: Defines the unique ID of the item in the List.
list_id str: The unique ID of the list.

accountId String: The Account ID for this resource.
itemId String: Defines the unique ID of the item in the List.
listId String: The unique ID of the list.

getListItem Result

The following output properties are available:

AccountId string: The Account ID for this resource.
Asn int: Defines a non-negative 32 bit integer.
Comment string: Defines an informative summary of the list item.
CreatedOn string: The RFC 3339 timestamp of when the list was created.
Hostname GetListItemHostname: Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
Id string: Defines the unique ID of the item in the List.
Ip string: An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
ItemId string: Defines the unique ID of the item in the List.
ListId string: The unique ID of the list.
ModifiedOn string: The RFC 3339 timestamp of when the list was last modified.
Redirect GetListItemRedirect: The definition of the redirect.

AccountId string: The Account ID for this resource.
Asn int: Defines a non-negative 32 bit integer.
Comment string: Defines an informative summary of the list item.
CreatedOn string: The RFC 3339 timestamp of when the list was created.
Hostname GetListItemHostname: Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
Id string: Defines the unique ID of the item in the List.
Ip string: An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
ItemId string: Defines the unique ID of the item in the List.
ListId string: The unique ID of the list.
ModifiedOn string: The RFC 3339 timestamp of when the list was last modified.
Redirect GetListItemRedirect: The definition of the redirect.

accountId String: The Account ID for this resource.
asn Integer: Defines a non-negative 32 bit integer.
comment String: Defines an informative summary of the list item.
createdOn String: The RFC 3339 timestamp of when the list was created.
hostname GetListItemHostname: Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
id String: Defines the unique ID of the item in the List.
ip String: An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
itemId String: Defines the unique ID of the item in the List.
listId String: The unique ID of the list.
modifiedOn String: The RFC 3339 timestamp of when the list was last modified.
redirect GetListItemRedirect: The definition of the redirect.

accountId string: The Account ID for this resource.
asn number: Defines a non-negative 32 bit integer.
comment string: Defines an informative summary of the list item.
createdOn string: The RFC 3339 timestamp of when the list was created.
hostname GetListItemHostname: Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
id string: Defines the unique ID of the item in the List.
ip string: An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
itemId string: Defines the unique ID of the item in the List.
listId string: The unique ID of the list.
modifiedOn string: The RFC 3339 timestamp of when the list was last modified.
redirect GetListItemRedirect: The definition of the redirect.

account_id str: The Account ID for this resource.
asn int: Defines a non-negative 32 bit integer.
comment str: Defines an informative summary of the list item.
created_on str: The RFC 3339 timestamp of when the list was created.
hostname GetListItemHostname: Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).
id str: Defines the unique ID of the item in the List.
ip str: An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
item_id str: Defines the unique ID of the item in the List.
list_id str: The unique ID of the list.
modified_on str: The RFC 3339 timestamp of when the list was last modified.
redirect GetListItemRedirect: The definition of the redirect.

accountId String: The Account ID for this resource.
asn Number: Defines a non-negative 32 bit integer.
comment String: Defines an informative summary of the list item.
createdOn String: The RFC 3339 timestamp of when the list was created.
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 (-).
id String: Defines the unique ID of the item in the List.
ip String: An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
itemId String: Defines the unique ID of the item in the List.
listId String: The unique ID of the list.
modifiedOn String: The RFC 3339 timestamp of when the list was last modified.
redirect Property Map: The definition of the redirect.

Supporting Types

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