1. Packages
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. getApiShield
Viewing docs for Cloudflare v6.15.0
published on Saturday, May 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

cloudflare.getApiShield

cloudflare logo
Viewing docs for Cloudflare v6.15.0
published on Saturday, May 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

    Accepted Permissions

    • Account API Gateway
    • Account API Gateway Read
    • Domain API Gateway
    • Domain API Gateway Read

    Example Usage

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

const exampleApiShield = cloudflare.getApiShield({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    normalize: true,
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_api_shield = cloudflare.get_api_shield(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    normalize=True)

    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.GetApiShield(ctx, &cloudflare.LookupApiShieldArgs{
			ZoneId:    pulumi.StringRef("023e105f4ecef8ad9ca31a8372d0c353"),
			Normalize: pulumi.BoolRef(true),
		}, 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 exampleApiShield = Cloudflare.Index.GetApiShield.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        Normalize = true,
    });

});

    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.GetApiShieldArgs;
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 exampleApiShield = CloudflareFunctions.getApiShield(GetApiShieldArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .normalize(true)
            .build());

    }
}

    variables:
  exampleApiShield:
    fn::invoke:
      function: cloudflare:getApiShield
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        normalize: true

    Using getApiShield

    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 getApiShield(args: GetApiShieldArgs, opts?: InvokeOptions): Promise<GetApiShieldResult>
function getApiShieldOutput(args: GetApiShieldOutputArgs, opts?: InvokeOptions): Output<GetApiShieldResult>
    def get_api_shield(normalize: Optional[bool] = None,
                   zone_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetApiShieldResult
def get_api_shield_output(normalize: Optional[pulumi.Input[bool]] = None,
                   zone_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetApiShieldResult]
    func LookupApiShield(ctx *Context, args *LookupApiShieldArgs, opts ...InvokeOption) (*LookupApiShieldResult, error)
func LookupApiShieldOutput(ctx *Context, args *LookupApiShieldOutputArgs, opts ...InvokeOption) LookupApiShieldResultOutput

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

    public static class GetApiShield 
{
    public static Task<GetApiShieldResult> InvokeAsync(GetApiShieldArgs args, InvokeOptions? opts = null)
    public static Output<GetApiShieldResult> Invoke(GetApiShieldInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiShieldResult> getApiShield(GetApiShieldArgs args, InvokeOptions options)
public static Output<GetApiShieldResult> getApiShield(GetApiShieldArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Normalize bool
    Ensures that the configuration is written or retrieved in normalized fashion
    ZoneId string
    Identifier.
    Normalize bool
    Ensures that the configuration is written or retrieved in normalized fashion
    ZoneId string
    Identifier.
    normalize Boolean
    Ensures that the configuration is written or retrieved in normalized fashion
    zoneId String
    Identifier.
    normalize boolean
    Ensures that the configuration is written or retrieved in normalized fashion
    zoneId string
    Identifier.
    normalize bool
    Ensures that the configuration is written or retrieved in normalized fashion
    zone_id str
    Identifier.
    normalize Boolean
    Ensures that the configuration is written or retrieved in normalized fashion
    zoneId String
    Identifier.

    getApiShield Result

    The following output properties are available:

    AuthIdCharacteristics List<GetApiShieldAuthIdCharacteristic>
    Id string
    Identifier.
    Normalize bool
    Ensures that the configuration is written or retrieved in normalized fashion
    ZoneId string
    Identifier.
    AuthIdCharacteristics []GetApiShieldAuthIdCharacteristic
    Id string
    Identifier.
    Normalize bool
    Ensures that the configuration is written or retrieved in normalized fashion
    ZoneId string
    Identifier.
    authIdCharacteristics List<GetApiShieldAuthIdCharacteristic>
    id String
    Identifier.
    normalize Boolean
    Ensures that the configuration is written or retrieved in normalized fashion
    zoneId String
    Identifier.
    authIdCharacteristics GetApiShieldAuthIdCharacteristic[]
    id string
    Identifier.
    normalize boolean
    Ensures that the configuration is written or retrieved in normalized fashion
    zoneId string
    Identifier.
    auth_id_characteristics Sequence[GetApiShieldAuthIdCharacteristic]
    id str
    Identifier.
    normalize bool
    Ensures that the configuration is written or retrieved in normalized fashion
    zone_id str
    Identifier.
    authIdCharacteristics List<Property Map>
    id String
    Identifier.
    normalize Boolean
    Ensures that the configuration is written or retrieved in normalized fashion
    zoneId String
    Identifier.

    Supporting Types

    GetApiShieldAuthIdCharacteristic

    Name string
    The name of the characteristic field, i.e., the header or cookie name.
    Type string
    The type of characteristic. Available values: "header", "cookie", "jwt".
    Name string
    The name of the characteristic field, i.e., the header or cookie name.
    Type string
    The type of characteristic. Available values: "header", "cookie", "jwt".
    name String
    The name of the characteristic field, i.e., the header or cookie name.
    type String
    The type of characteristic. Available values: "header", "cookie", "jwt".
    name string
    The name of the characteristic field, i.e., the header or cookie name.
    type string
    The type of characteristic. Available values: "header", "cookie", "jwt".
    name str
    The name of the characteristic field, i.e., the header or cookie name.
    type str
    The type of characteristic. Available values: "header", "cookie", "jwt".
    name String
    The name of the characteristic field, i.e., the header or cookie name.
    type String
    The type of characteristic. Available values: "header", "cookie", "jwt".

    Package Details

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