1. Registry
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. getZeroTrustList
Viewing docs for Cloudflare v6.23.1
published on Wednesday, Oct 21, 2026 by Pulumi
cloudflare logo cloudflare logo
Viewing docs for Cloudflare v6.23.1
published on Wednesday, Oct 21, 2026 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleZeroTrustList = cloudflare.getZeroTrustList({
        accountId: "699d98642c564d2e855e9661899b7252",
        listId: "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_zero_trust_list = cloudflare.get_zero_trust_list(account_id="699d98642c564d2e855e9661899b7252",
        list_id="f174e90a-fafe-4643-bbbc-4a0ed4fc8415")
    
    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.GetZeroTrustList(ctx, &cloudflare.LookupZeroTrustListArgs{
    			AccountId: pulumi.StringRef("699d98642c564d2e855e9661899b7252"),
    			ListId:    pulumi.StringRef("f174e90a-fafe-4643-bbbc-4a0ed4fc8415"),
    		}, 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 exampleZeroTrustList = Cloudflare.GetZeroTrustList.Invoke(new()
        {
            AccountId = "699d98642c564d2e855e9661899b7252",
            ListId = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        });
    
    });
    
    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.GetZeroTrustListArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 exampleZeroTrustList = CloudflareFunctions.getZeroTrustList(GetZeroTrustListArgs.builder()
                .accountId("699d98642c564d2e855e9661899b7252")
                .listId("f174e90a-fafe-4643-bbbc-4a0ed4fc8415")
                .build());
    
        }
    }
    
    variables:
      exampleZeroTrustList:
        fn::invoke:
          function: cloudflare:getZeroTrustList
          arguments:
            accountId: 699d98642c564d2e855e9661899b7252
            listId: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
    
    terraform {
      required_providers {
        cloudflare = {
          source = "pulumi/cloudflare"
        }
      }
    }
    
    data "cloudflare_zero_trust_list" "exampleZeroTrustList" {
      account_id = "699d98642c564d2e855e9661899b7252"
      list_id    = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
    }
    

    Using getZeroTrustList

    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 getZeroTrustList(args: GetZeroTrustListArgs, opts?: InvokeOptions): Promise<GetZeroTrustListResult>
    function getZeroTrustListOutput(args: GetZeroTrustListOutputArgs, opts?: InvokeOutputOptions): Output<GetZeroTrustListResult>
    def get_zero_trust_list(account_id: Optional[str] = None,
                            filter: Optional[GetZeroTrustListFilter] = None,
                            list_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetZeroTrustListResult
    def get_zero_trust_list_output(account_id: pulumi.Input[Optional[str]] = None,
                            filter: pulumi.Input[Optional[GetZeroTrustListFilterArgs]] = None,
                            list_id: pulumi.Input[Optional[str]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetZeroTrustListResult]
    func LookupZeroTrustList(ctx *Context, args *LookupZeroTrustListArgs, opts ...InvokeOption) (*LookupZeroTrustListResult, error)
    func LookupZeroTrustListOutput(ctx *Context, args *LookupZeroTrustListOutputArgs, opts ...InvokeOption) LookupZeroTrustListResultOutput

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

    public static class GetZeroTrustList 
    {
        public static Task<GetZeroTrustListResult> InvokeAsync(GetZeroTrustListArgs args, InvokeOptions? opts = null)
        public static Output<GetZeroTrustListResult> Invoke(GetZeroTrustListInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetZeroTrustListResult> Invoke(GetZeroTrustListInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetZeroTrustListResult> getZeroTrustList(GetZeroTrustListArgs args, InvokeOptions options)
    public static Output<GetZeroTrustListResult> getZeroTrustList(GetZeroTrustListArgs args, InvokeOptions options)
    public static Output<GetZeroTrustListResult> getZeroTrustList(GetZeroTrustListArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: cloudflare:index/getZeroTrustList:getZeroTrustList
      arguments:
        # arguments dictionary
    data "cloudflare_get_zero_trust_list" "name" {
        # arguments
    }

    The following arguments are supported:

    getZeroTrustList Result

    The following output properties are available:

    created_at string
    description string
    id string
    items list(object)
    list_count number
    name string
    type string
    updated_at string
    account_id string
    filter object
    list_id string

    Supporting Types

    GetZeroTrustListFilter

    Direction string
    Sort direction. Applies to the field named in orderBy; when orderBy is omitted it applies to the default createdAt ordering. When direction is omitted the default is field-specific: explicitly choosing createdAt or updatedAt defaults to descending (newest first); name and itemCount default to ascending; and the default createdAt ordering used when orderBy is omitted is ascending (for backwards compatibility).

    • asc — ascending.
    • desc — descending. Available values: "asc", "desc".
    Filters List<string>

    Filter the returned lists by one or more field:value pairs. Repeat the parameter to apply multiple filters; they are combined with logical AND (a list must satisfy every filter to be returned).

    Supported fields and their matching behaviour:

    • name — case-insensitive substring match on the list name.
    • id — substring match on the list ID (UUID), with or without dashes.
    • type — exact match on the list type. Supersedes the legacy type query parameter when both are supplied. Must be one of the valid type values.
    • itemCount — exact integer match on the number of items in the list.

    Each entry must match one of the per-field patterns below: the field must be one of name, id, type, or itemCount; name/id accept any value, type is restricted to the valid list type values, and itemCount must be a non-negative integer.

    OrderBy string
    Field to sort the returned lists by. When omitted, results are ordered by createdAt in ascending order (i.e. creation order) for backwards compatibility. Supported values:

    • name — sort alphabetically by list name.
    • createdAt — sort by creation time; defaults to descending unless direction is set.
    • updatedAt — sort by last-modified time; defaults to descending unless direction is set.
    • itemCount — sort by number of items in the list. Available values: "name", "createdAt", "updatedAt", "itemCount".
    Search string
    Case-insensitive substring match on the list name or description. When combined with filter, both must match (logical AND).
    Type string
    Specify the list type. Available values: "SERIAL", "URL", "DOMAIN", "EMAIL", "IP", "CATEGORY", "LOCATION", "DEVICE", "AAGUID".
    Direction string
    Sort direction. Applies to the field named in orderBy; when orderBy is omitted it applies to the default createdAt ordering. When direction is omitted the default is field-specific: explicitly choosing createdAt or updatedAt defaults to descending (newest first); name and itemCount default to ascending; and the default createdAt ordering used when orderBy is omitted is ascending (for backwards compatibility).

    • asc — ascending.
    • desc — descending. Available values: "asc", "desc".
    Filters []string

    Filter the returned lists by one or more field:value pairs. Repeat the parameter to apply multiple filters; they are combined with logical AND (a list must satisfy every filter to be returned).

    Supported fields and their matching behaviour:

    • name — case-insensitive substring match on the list name.
    • id — substring match on the list ID (UUID), with or without dashes.
    • type — exact match on the list type. Supersedes the legacy type query parameter when both are supplied. Must be one of the valid type values.
    • itemCount — exact integer match on the number of items in the list.

    Each entry must match one of the per-field patterns below: the field must be one of name, id, type, or itemCount; name/id accept any value, type is restricted to the valid list type values, and itemCount must be a non-negative integer.

    OrderBy string
    Field to sort the returned lists by. When omitted, results are ordered by createdAt in ascending order (i.e. creation order) for backwards compatibility. Supported values:

    • name — sort alphabetically by list name.
    • createdAt — sort by creation time; defaults to descending unless direction is set.
    • updatedAt — sort by last-modified time; defaults to descending unless direction is set.
    • itemCount — sort by number of items in the list. Available values: "name", "createdAt", "updatedAt", "itemCount".
    Search string
    Case-insensitive substring match on the list name or description. When combined with filter, both must match (logical AND).
    Type string
    Specify the list type. Available values: "SERIAL", "URL", "DOMAIN", "EMAIL", "IP", "CATEGORY", "LOCATION", "DEVICE", "AAGUID".
    direction string
    Sort direction. Applies to the field named in orderBy; when orderBy is omitted it applies to the default createdAt ordering. When direction is omitted the default is field-specific: explicitly choosing createdAt or updatedAt defaults to descending (newest first); name and itemCount default to ascending; and the default createdAt ordering used when orderBy is omitted is ascending (for backwards compatibility).

    • asc — ascending.
    • desc — descending. Available values: "asc", "desc".
    filters list(string)

    Filter the returned lists by one or more field:value pairs. Repeat the parameter to apply multiple filters; they are combined with logical AND (a list must satisfy every filter to be returned).

    Supported fields and their matching behaviour:

    • name — case-insensitive substring match on the list name.
    • id — substring match on the list ID (UUID), with or without dashes.
    • type — exact match on the list type. Supersedes the legacy type query parameter when both are supplied. Must be one of the valid type values.
    • itemCount — exact integer match on the number of items in the list.

    Each entry must match one of the per-field patterns below: the field must be one of name, id, type, or itemCount; name/id accept any value, type is restricted to the valid list type values, and itemCount must be a non-negative integer.

    order_by string
    Field to sort the returned lists by. When omitted, results are ordered by createdAt in ascending order (i.e. creation order) for backwards compatibility. Supported values:

    • name — sort alphabetically by list name.
    • createdAt — sort by creation time; defaults to descending unless direction is set.
    • updatedAt — sort by last-modified time; defaults to descending unless direction is set.
    • itemCount — sort by number of items in the list. Available values: "name", "createdAt", "updatedAt", "itemCount".
    search string
    Case-insensitive substring match on the list name or description. When combined with filter, both must match (logical AND).
    type string
    Specify the list type. Available values: "SERIAL", "URL", "DOMAIN", "EMAIL", "IP", "CATEGORY", "LOCATION", "DEVICE", "AAGUID".
    direction String
    Sort direction. Applies to the field named in orderBy; when orderBy is omitted it applies to the default createdAt ordering. When direction is omitted the default is field-specific: explicitly choosing createdAt or updatedAt defaults to descending (newest first); name and itemCount default to ascending; and the default createdAt ordering used when orderBy is omitted is ascending (for backwards compatibility).

    • asc — ascending.
    • desc — descending. Available values: "asc", "desc".
    filters List<String>

    Filter the returned lists by one or more field:value pairs. Repeat the parameter to apply multiple filters; they are combined with logical AND (a list must satisfy every filter to be returned).

    Supported fields and their matching behaviour:

    • name — case-insensitive substring match on the list name.
    • id — substring match on the list ID (UUID), with or without dashes.
    • type — exact match on the list type. Supersedes the legacy type query parameter when both are supplied. Must be one of the valid type values.
    • itemCount — exact integer match on the number of items in the list.

    Each entry must match one of the per-field patterns below: the field must be one of name, id, type, or itemCount; name/id accept any value, type is restricted to the valid list type values, and itemCount must be a non-negative integer.

    orderBy String
    Field to sort the returned lists by. When omitted, results are ordered by createdAt in ascending order (i.e. creation order) for backwards compatibility. Supported values:

    • name — sort alphabetically by list name.
    • createdAt — sort by creation time; defaults to descending unless direction is set.
    • updatedAt — sort by last-modified time; defaults to descending unless direction is set.
    • itemCount — sort by number of items in the list. Available values: "name", "createdAt", "updatedAt", "itemCount".
    search String
    Case-insensitive substring match on the list name or description. When combined with filter, both must match (logical AND).
    type String
    Specify the list type. Available values: "SERIAL", "URL", "DOMAIN", "EMAIL", "IP", "CATEGORY", "LOCATION", "DEVICE", "AAGUID".
    direction string
    Sort direction. Applies to the field named in orderBy; when orderBy is omitted it applies to the default createdAt ordering. When direction is omitted the default is field-specific: explicitly choosing createdAt or updatedAt defaults to descending (newest first); name and itemCount default to ascending; and the default createdAt ordering used when orderBy is omitted is ascending (for backwards compatibility).

    • asc — ascending.
    • desc — descending. Available values: "asc", "desc".
    filters string[]

    Filter the returned lists by one or more field:value pairs. Repeat the parameter to apply multiple filters; they are combined with logical AND (a list must satisfy every filter to be returned).

    Supported fields and their matching behaviour:

    • name — case-insensitive substring match on the list name.
    • id — substring match on the list ID (UUID), with or without dashes.
    • type — exact match on the list type. Supersedes the legacy type query parameter when both are supplied. Must be one of the valid type values.
    • itemCount — exact integer match on the number of items in the list.

    Each entry must match one of the per-field patterns below: the field must be one of name, id, type, or itemCount; name/id accept any value, type is restricted to the valid list type values, and itemCount must be a non-negative integer.

    orderBy string
    Field to sort the returned lists by. When omitted, results are ordered by createdAt in ascending order (i.e. creation order) for backwards compatibility. Supported values:

    • name — sort alphabetically by list name.
    • createdAt — sort by creation time; defaults to descending unless direction is set.
    • updatedAt — sort by last-modified time; defaults to descending unless direction is set.
    • itemCount — sort by number of items in the list. Available values: "name", "createdAt", "updatedAt", "itemCount".
    search string
    Case-insensitive substring match on the list name or description. When combined with filter, both must match (logical AND).
    type string
    Specify the list type. Available values: "SERIAL", "URL", "DOMAIN", "EMAIL", "IP", "CATEGORY", "LOCATION", "DEVICE", "AAGUID".
    direction str
    Sort direction. Applies to the field named in orderBy; when orderBy is omitted it applies to the default createdAt ordering. When direction is omitted the default is field-specific: explicitly choosing createdAt or updatedAt defaults to descending (newest first); name and itemCount default to ascending; and the default createdAt ordering used when orderBy is omitted is ascending (for backwards compatibility).

    • asc — ascending.
    • desc — descending. Available values: "asc", "desc".
    filters Sequence[str]

    Filter the returned lists by one or more field:value pairs. Repeat the parameter to apply multiple filters; they are combined with logical AND (a list must satisfy every filter to be returned).

    Supported fields and their matching behaviour:

    • name — case-insensitive substring match on the list name.
    • id — substring match on the list ID (UUID), with or without dashes.
    • type — exact match on the list type. Supersedes the legacy type query parameter when both are supplied. Must be one of the valid type values.
    • itemCount — exact integer match on the number of items in the list.

    Each entry must match one of the per-field patterns below: the field must be one of name, id, type, or itemCount; name/id accept any value, type is restricted to the valid list type values, and itemCount must be a non-negative integer.

    order_by str
    Field to sort the returned lists by. When omitted, results are ordered by createdAt in ascending order (i.e. creation order) for backwards compatibility. Supported values:

    • name — sort alphabetically by list name.
    • createdAt — sort by creation time; defaults to descending unless direction is set.
    • updatedAt — sort by last-modified time; defaults to descending unless direction is set.
    • itemCount — sort by number of items in the list. Available values: "name", "createdAt", "updatedAt", "itemCount".
    search str
    Case-insensitive substring match on the list name or description. When combined with filter, both must match (logical AND).
    type str
    Specify the list type. Available values: "SERIAL", "URL", "DOMAIN", "EMAIL", "IP", "CATEGORY", "LOCATION", "DEVICE", "AAGUID".
    direction String
    Sort direction. Applies to the field named in orderBy; when orderBy is omitted it applies to the default createdAt ordering. When direction is omitted the default is field-specific: explicitly choosing createdAt or updatedAt defaults to descending (newest first); name and itemCount default to ascending; and the default createdAt ordering used when orderBy is omitted is ascending (for backwards compatibility).

    • asc — ascending.
    • desc — descending. Available values: "asc", "desc".
    filters List<String>

    Filter the returned lists by one or more field:value pairs. Repeat the parameter to apply multiple filters; they are combined with logical AND (a list must satisfy every filter to be returned).

    Supported fields and their matching behaviour:

    • name — case-insensitive substring match on the list name.
    • id — substring match on the list ID (UUID), with or without dashes.
    • type — exact match on the list type. Supersedes the legacy type query parameter when both are supplied. Must be one of the valid type values.
    • itemCount — exact integer match on the number of items in the list.

    Each entry must match one of the per-field patterns below: the field must be one of name, id, type, or itemCount; name/id accept any value, type is restricted to the valid list type values, and itemCount must be a non-negative integer.

    orderBy String
    Field to sort the returned lists by. When omitted, results are ordered by createdAt in ascending order (i.e. creation order) for backwards compatibility. Supported values:

    • name — sort alphabetically by list name.
    • createdAt — sort by creation time; defaults to descending unless direction is set.
    • updatedAt — sort by last-modified time; defaults to descending unless direction is set.
    • itemCount — sort by number of items in the list. Available values: "name", "createdAt", "updatedAt", "itemCount".
    search String
    Case-insensitive substring match on the list name or description. When combined with filter, both must match (logical AND).
    type String
    Specify the list type. Available values: "SERIAL", "URL", "DOMAIN", "EMAIL", "IP", "CATEGORY", "LOCATION", "DEVICE", "AAGUID".

    GetZeroTrustListItem

    CreatedAt string
    Description string
    Provide the list item description (optional).
    Value string
    Specify the item value.
    CreatedAt string
    Description string
    Provide the list item description (optional).
    Value string
    Specify the item value.
    created_at string
    description string
    Provide the list item description (optional).
    value string
    Specify the item value.
    createdAt String
    description String
    Provide the list item description (optional).
    value String
    Specify the item value.
    createdAt string
    description string
    Provide the list item description (optional).
    value string
    Specify the item value.
    created_at str
    description str
    Provide the list item description (optional).
    value str
    Specify the item value.
    createdAt String
    description String
    Provide the list item description (optional).
    value String
    Specify the item value.

    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 logo
    Viewing docs for Cloudflare v6.23.1
    published on Wednesday, Oct 21, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial