cloudflare.getApiShieldSchema

Start a Neo task

Explain and create a cloudflare.getApiShieldSchema resource

Cloudflare v6.11.0 published on Friday, Oct 31, 2025 by Pulumi

pulumi/pulumi-cloudflare

Example Usage

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

const exampleApiShieldSchema = cloudflare.getApiShieldSchema({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    schemaId: "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    omitSource: true,
});

import pulumi
import pulumi_cloudflare as cloudflare

example_api_shield_schema = cloudflare.get_api_shield_schema(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    schema_id="f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    omit_source=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.LookupApiShieldSchema(ctx, &cloudflare.LookupApiShieldSchemaArgs{
			ZoneId:     "023e105f4ecef8ad9ca31a8372d0c353",
			SchemaId:   "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
			OmitSource: 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 exampleApiShieldSchema = Cloudflare.GetApiShieldSchema.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        SchemaId = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        OmitSource = 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.GetApiShieldSchemaArgs;
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 exampleApiShieldSchema = CloudflareFunctions.getApiShieldSchema(GetApiShieldSchemaArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .schemaId("f174e90a-fafe-4643-bbbc-4a0ed4fc8415")
            .omitSource(true)
            .build());

    }
}

variables:
  exampleApiShieldSchema:
    fn::invoke:
      function: cloudflare:getApiShieldSchema
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        schemaId: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
        omitSource: true

Using getApiShieldSchema

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 getApiShieldSchema(args: GetApiShieldSchemaArgs, opts?: InvokeOptions): Promise<GetApiShieldSchemaResult>
function getApiShieldSchemaOutput(args: GetApiShieldSchemaOutputArgs, opts?: InvokeOptions): Output<GetApiShieldSchemaResult>

def get_api_shield_schema(omit_source: Optional[bool] = None,
                          schema_id: Optional[str] = None,
                          zone_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetApiShieldSchemaResult
def get_api_shield_schema_output(omit_source: Optional[pulumi.Input[bool]] = None,
                          schema_id: Optional[pulumi.Input[str]] = None,
                          zone_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetApiShieldSchemaResult]

func LookupApiShieldSchema(ctx *Context, args *LookupApiShieldSchemaArgs, opts ...InvokeOption) (*LookupApiShieldSchemaResult, error)
func LookupApiShieldSchemaOutput(ctx *Context, args *LookupApiShieldSchemaOutputArgs, opts ...InvokeOption) LookupApiShieldSchemaResultOutput

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

public static class GetApiShieldSchema 
{
    public static Task<GetApiShieldSchemaResult> InvokeAsync(GetApiShieldSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetApiShieldSchemaResult> Invoke(GetApiShieldSchemaInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiShieldSchemaResult> getApiShieldSchema(GetApiShieldSchemaArgs args, InvokeOptions options)
public static Output<GetApiShieldSchemaResult> getApiShieldSchema(GetApiShieldSchemaArgs args, InvokeOptions options)

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

The following arguments are supported:

SchemaId string
ZoneId string: Identifier.
OmitSource bool: Omit the source-files of schemas and only retrieve their meta-data.

SchemaId string
ZoneId string: Identifier.
OmitSource bool: Omit the source-files of schemas and only retrieve their meta-data.

schemaId String
zoneId String: Identifier.
omitSource Boolean: Omit the source-files of schemas and only retrieve their meta-data.

schemaId string
zoneId string: Identifier.
omitSource boolean: Omit the source-files of schemas and only retrieve their meta-data.

schema_id str
zone_id str: Identifier.
omit_source bool: Omit the source-files of schemas and only retrieve their meta-data.

schemaId String
zoneId String: Identifier.
omitSource Boolean: Omit the source-files of schemas and only retrieve their meta-data.

getApiShieldSchema Result

The following output properties are available:

CreatedAt string
Id string: The provider-assigned unique ID for this managed resource.
Kind string: Kind of schema Available values: "openapi_v3".
Name string: Name of the schema
OmitSource bool: Omit the source-files of schemas and only retrieve their meta-data.
SchemaId string
Source string: Source of the schema
ValidationEnabled bool: Flag whether schema is enabled for validation.
ZoneId string: Identifier.

CreatedAt string
Id string: The provider-assigned unique ID for this managed resource.
Kind string: Kind of schema Available values: "openapi_v3".
Name string: Name of the schema
OmitSource bool: Omit the source-files of schemas and only retrieve their meta-data.
SchemaId string
Source string: Source of the schema
ValidationEnabled bool: Flag whether schema is enabled for validation.
ZoneId string: Identifier.

createdAt String
id String: The provider-assigned unique ID for this managed resource.
kind String: Kind of schema Available values: "openapi_v3".
name String: Name of the schema
omitSource Boolean: Omit the source-files of schemas and only retrieve their meta-data.
schemaId String
source String: Source of the schema
validationEnabled Boolean: Flag whether schema is enabled for validation.
zoneId String: Identifier.

createdAt string
id string: The provider-assigned unique ID for this managed resource.
kind string: Kind of schema Available values: "openapi_v3".
name string: Name of the schema
omitSource boolean: Omit the source-files of schemas and only retrieve their meta-data.
schemaId string
source string: Source of the schema
validationEnabled boolean: Flag whether schema is enabled for validation.
zoneId string: Identifier.

created_at str
id str: The provider-assigned unique ID for this managed resource.
kind str: Kind of schema Available values: "openapi_v3".
name str: Name of the schema
omit_source bool: Omit the source-files of schemas and only retrieve their meta-data.
schema_id str
source str: Source of the schema
validation_enabled bool: Flag whether schema is enabled for validation.
zone_id str: Identifier.

createdAt String
id String: The provider-assigned unique ID for this managed resource.
kind String: Kind of schema Available values: "openapi_v3".
name String: Name of the schema
omitSource Boolean: Omit the source-files of schemas and only retrieve their meta-data.
schemaId String
source String: Source of the schema
validationEnabled Boolean: Flag whether schema is enabled for validation.
zoneId String: Identifier.

Package Details

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

Cloudflare v6.11.0 published on Friday, Oct 31, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getApiShieldSchema

On this page

On this page

Example Usage

Using getApiShieldSchema

getApiShieldSchema Result

Package Details

On this page

On this page