Cloudflare v6.0.1, Apr 16 25

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

cloudflare.getTurnstileWidgets

Explore with Pulumi AI

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

Example Usage

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

const exampleTurnstileWidgets = cloudflare.getTurnstileWidgets({
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    direction: "asc",
    order: "id",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_turnstile_widgets = cloudflare.get_turnstile_widgets(account_id="023e105f4ecef8ad9ca31a8372d0c353",
    direction="asc",
    order="id")

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.LookupTurnstileWidgets(ctx, &cloudflare.LookupTurnstileWidgetsArgs{
			AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
			Direction: pulumi.StringRef("asc"),
			Order:     pulumi.StringRef("id"),
		}, 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 exampleTurnstileWidgets = Cloudflare.GetTurnstileWidgets.Invoke(new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        Direction = "asc",
        Order = "id",
    });

});

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.GetTurnstileWidgetsArgs;
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 exampleTurnstileWidgets = CloudflareFunctions.getTurnstileWidgets(GetTurnstileWidgetsArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .direction("asc")
            .order("id")
            .build());

    }
}

variables:
  exampleTurnstileWidgets:
    fn::invoke:
      function: cloudflare:getTurnstileWidgets
      arguments:
        accountId: 023e105f4ecef8ad9ca31a8372d0c353
        direction: asc
        order: id

Using getTurnstileWidgets

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 getTurnstileWidgets(args: GetTurnstileWidgetsArgs, opts?: InvokeOptions): Promise<GetTurnstileWidgetsResult>
function getTurnstileWidgetsOutput(args: GetTurnstileWidgetsOutputArgs, opts?: InvokeOptions): Output<GetTurnstileWidgetsResult>

def get_turnstile_widgets(account_id: Optional[str] = None,
                          direction: Optional[str] = None,
                          max_items: Optional[int] = None,
                          order: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetTurnstileWidgetsResult
def get_turnstile_widgets_output(account_id: Optional[pulumi.Input[str]] = None,
                          direction: Optional[pulumi.Input[str]] = None,
                          max_items: Optional[pulumi.Input[int]] = None,
                          order: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetTurnstileWidgetsResult]

func LookupTurnstileWidgets(ctx *Context, args *LookupTurnstileWidgetsArgs, opts ...InvokeOption) (*LookupTurnstileWidgetsResult, error)
func LookupTurnstileWidgetsOutput(ctx *Context, args *LookupTurnstileWidgetsOutputArgs, opts ...InvokeOption) LookupTurnstileWidgetsResultOutput

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

public static class GetTurnstileWidgets 
{
    public static Task<GetTurnstileWidgetsResult> InvokeAsync(GetTurnstileWidgetsArgs args, InvokeOptions? opts = null)
    public static Output<GetTurnstileWidgetsResult> Invoke(GetTurnstileWidgetsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTurnstileWidgetsResult> getTurnstileWidgets(GetTurnstileWidgetsArgs args, InvokeOptions options)
public static Output<GetTurnstileWidgetsResult> getTurnstileWidgets(GetTurnstileWidgetsArgs args, InvokeOptions options)

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

The following arguments are supported:

AccountId string: Identifier
Direction string: Direction to order widgets. Available values: "asc", "desc".
MaxItems int: Max items to fetch, default: 1000
Order string: Field to order widgets by. Available values: "id", "sitekey", "name", "createdon", "modifiedon".

AccountId string: Identifier
Direction string: Direction to order widgets. Available values: "asc", "desc".
MaxItems int: Max items to fetch, default: 1000
Order string: Field to order widgets by. Available values: "id", "sitekey", "name", "createdon", "modifiedon".

accountId String: Identifier
direction String: Direction to order widgets. Available values: "asc", "desc".
maxItems Integer: Max items to fetch, default: 1000
order String: Field to order widgets by. Available values: "id", "sitekey", "name", "createdon", "modifiedon".

accountId string: Identifier
direction string: Direction to order widgets. Available values: "asc", "desc".
maxItems number: Max items to fetch, default: 1000
order string: Field to order widgets by. Available values: "id", "sitekey", "name", "createdon", "modifiedon".

account_id str: Identifier
direction str: Direction to order widgets. Available values: "asc", "desc".
max_items int: Max items to fetch, default: 1000
order str: Field to order widgets by. Available values: "id", "sitekey", "name", "createdon", "modifiedon".

accountId String: Identifier
direction String: Direction to order widgets. Available values: "asc", "desc".
maxItems Number: Max items to fetch, default: 1000
order String: Field to order widgets by. Available values: "id", "sitekey", "name", "createdon", "modifiedon".

getTurnstileWidgets Result

The following output properties are available:

AccountId string: Identifier
Id string: The provider-assigned unique ID for this managed resource.
Results List<GetTurnstileWidgetsResult>: The items returned by the data source
Direction string: Direction to order widgets. Available values: "asc", "desc".
MaxItems int: Max items to fetch, default: 1000
Order string: Field to order widgets by. Available values: "id", "sitekey", "name", "createdon", "modifiedon".

AccountId string: Identifier
Id string: The provider-assigned unique ID for this managed resource.
Results []GetTurnstileWidgetsResult: The items returned by the data source
Direction string: Direction to order widgets. Available values: "asc", "desc".
MaxItems int: Max items to fetch, default: 1000
Order string: Field to order widgets by. Available values: "id", "sitekey", "name", "createdon", "modifiedon".

accountId String: Identifier
id String: The provider-assigned unique ID for this managed resource.
results List<GetTurnstileWidgetsResult>: The items returned by the data source
direction String: Direction to order widgets. Available values: "asc", "desc".
maxItems Integer: Max items to fetch, default: 1000
order String: Field to order widgets by. Available values: "id", "sitekey", "name", "createdon", "modifiedon".

accountId string: Identifier
id string: The provider-assigned unique ID for this managed resource.
results GetTurnstileWidgetsResult[]: The items returned by the data source
direction string: Direction to order widgets. Available values: "asc", "desc".
maxItems number: Max items to fetch, default: 1000
order string: Field to order widgets by. Available values: "id", "sitekey", "name", "createdon", "modifiedon".

account_id str: Identifier
id str: The provider-assigned unique ID for this managed resource.
results Sequence[GetTurnstileWidgetsResult]: The items returned by the data source
direction str: Direction to order widgets. Available values: "asc", "desc".
max_items int: Max items to fetch, default: 1000
order str: Field to order widgets by. Available values: "id", "sitekey", "name", "createdon", "modifiedon".

accountId String: Identifier
id String: The provider-assigned unique ID for this managed resource.
results List<Property Map>: The items returned by the data source
direction String: Direction to order widgets. Available values: "asc", "desc".
maxItems Number: Max items to fetch, default: 1000
order String: Field to order widgets by. Available values: "id", "sitekey", "name", "createdon", "modifiedon".

Supporting Types

GetTurnstileWidgetsResult

BotFightMode bool: If botfightmode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only).
ClearanceLevel string: If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set Available values: "no_clearance", "jschallenge", "managed", "interactive".
CreatedOn string: When the widget was created.
Domains List<string>
EphemeralId bool: Return the Ephemeral ID in /siteverify (ENT only).
Mode string: Widget Mode Available values: "non-interactive", "invisible", "managed".
ModifiedOn string: When the widget was modified.
Name string: Human readable widget name. Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used.
Offlabel bool: Do not show any Cloudflare branding on the widget (ENT only).
Region string: Region where this widget can be used. Available values: "world".
Sitekey string: Widget item identifier tag.

BotFightMode bool: If botfightmode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only).
ClearanceLevel string: If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set Available values: "no_clearance", "jschallenge", "managed", "interactive".
CreatedOn string: When the widget was created.
Domains []string
EphemeralId bool: Return the Ephemeral ID in /siteverify (ENT only).
Mode string: Widget Mode Available values: "non-interactive", "invisible", "managed".
ModifiedOn string: When the widget was modified.
Name string: Human readable widget name. Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used.
Offlabel bool: Do not show any Cloudflare branding on the widget (ENT only).
Region string: Region where this widget can be used. Available values: "world".
Sitekey string: Widget item identifier tag.

botFightMode Boolean: If botfightmode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only).
clearanceLevel String: If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set Available values: "no_clearance", "jschallenge", "managed", "interactive".
createdOn String: When the widget was created.
domains List<String>
ephemeralId Boolean: Return the Ephemeral ID in /siteverify (ENT only).
mode String: Widget Mode Available values: "non-interactive", "invisible", "managed".
modifiedOn String: When the widget was modified.
name String: Human readable widget name. Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used.
offlabel Boolean: Do not show any Cloudflare branding on the widget (ENT only).
region String: Region where this widget can be used. Available values: "world".
sitekey String: Widget item identifier tag.

botFightMode boolean: If botfightmode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only).
clearanceLevel string: If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set Available values: "no_clearance", "jschallenge", "managed", "interactive".
createdOn string: When the widget was created.
domains string[]
ephemeralId boolean: Return the Ephemeral ID in /siteverify (ENT only).
mode string: Widget Mode Available values: "non-interactive", "invisible", "managed".
modifiedOn string: When the widget was modified.
name string: Human readable widget name. Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used.
offlabel boolean: Do not show any Cloudflare branding on the widget (ENT only).
region string: Region where this widget can be used. Available values: "world".
sitekey string: Widget item identifier tag.

bot_fight_mode bool: If botfightmode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only).
clearance_level str: If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set Available values: "no_clearance", "jschallenge", "managed", "interactive".
created_on str: When the widget was created.
domains Sequence[str]
ephemeral_id bool: Return the Ephemeral ID in /siteverify (ENT only).
mode str: Widget Mode Available values: "non-interactive", "invisible", "managed".
modified_on str: When the widget was modified.
name str: Human readable widget name. Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used.
offlabel bool: Do not show any Cloudflare branding on the widget (ENT only).
region str: Region where this widget can be used. Available values: "world".
sitekey str: Widget item identifier tag.

botFightMode Boolean: If botfightmode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only).
clearanceLevel String: If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set Available values: "no_clearance", "jschallenge", "managed", "interactive".
createdOn String: When the widget was created.
domains List<String>
ephemeralId Boolean: Return the Ephemeral ID in /siteverify (ENT only).
mode String: Widget Mode Available values: "non-interactive", "invisible", "managed".
modifiedOn String: When the widget was modified.
name String: Human readable widget name. Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used.
offlabel Boolean: Do not show any Cloudflare branding on the widget (ENT only).
region String: Region where this widget can be used. Available values: "world".
sitekey String: Widget item identifier tag.

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getTurnstileWidgets

On this page

On this page

Example Usage

Using getTurnstileWidgets

getTurnstileWidgets Result

Supporting Types

GetTurnstileWidgetsResult

Package Details

On this page

On this page