Cloudflare v6.1.1, Apr 21 25

Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

cloudflare.getApiShieldOperations

Explore with Pulumi AI

Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const exampleApiShieldOperations = cloudflare.getApiShieldOperations({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    direction: "desc",
    endpoint: "/api/v1",
    features: ["thresholds"],
    hosts: ["api.cloudflare.com"],
    methods: ["GET"],
    order: "method",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_api_shield_operations = cloudflare.get_api_shield_operations(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    direction="desc",
    endpoint="/api/v1",
    features=["thresholds"],
    hosts=["api.cloudflare.com"],
    methods=["GET"],
    order="method")

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.LookupApiShieldOperations(ctx, &cloudflare.LookupApiShieldOperationsArgs{
			ZoneId:    "023e105f4ecef8ad9ca31a8372d0c353",
			Direction: pulumi.StringRef("desc"),
			Endpoint:  pulumi.StringRef("/api/v1"),
			Features: []string{
				"thresholds",
			},
			Hosts: []string{
				"api.cloudflare.com",
			},
			Methods: []string{
				"GET",
			},
			Order: pulumi.StringRef("method"),
		}, 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 exampleApiShieldOperations = Cloudflare.GetApiShieldOperations.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        Direction = "desc",
        Endpoint = "/api/v1",
        Features = new[]
        {
            "thresholds",
        },
        Hosts = new[]
        {
            "api.cloudflare.com",
        },
        Methods = new[]
        {
            "GET",
        },
        Order = "method",
    });

});

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.GetApiShieldOperationsArgs;
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 exampleApiShieldOperations = CloudflareFunctions.getApiShieldOperations(GetApiShieldOperationsArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .direction("desc")
            .endpoint("/api/v1")
            .features("thresholds")
            .hosts("api.cloudflare.com")
            .methods("GET")
            .order("method")
            .build());

    }
}

variables:
  exampleApiShieldOperations:
    fn::invoke:
      function: cloudflare:getApiShieldOperations
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        direction: desc
        endpoint: /api/v1
        features:
          - thresholds
        hosts:
          - api.cloudflare.com
        methods:
          - GET
        order: method

Using getApiShieldOperations

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.

TypeScript
Python
Go
C#
Java
YAML

function getApiShieldOperations(args: GetApiShieldOperationsArgs, opts?: InvokeOptions): Promise<GetApiShieldOperationsResult>
function getApiShieldOperationsOutput(args: GetApiShieldOperationsOutputArgs, opts?: InvokeOptions): Output<GetApiShieldOperationsResult>

def get_api_shield_operations(direction: Optional[str] = None,
                              endpoint: Optional[str] = None,
                              features: Optional[Sequence[str]] = None,
                              hosts: Optional[Sequence[str]] = None,
                              max_items: Optional[int] = None,
                              methods: Optional[Sequence[str]] = None,
                              order: Optional[str] = None,
                              zone_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetApiShieldOperationsResult
def get_api_shield_operations_output(direction: Optional[pulumi.Input[str]] = None,
                              endpoint: Optional[pulumi.Input[str]] = None,
                              features: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                              hosts: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                              max_items: Optional[pulumi.Input[int]] = None,
                              methods: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                              order: Optional[pulumi.Input[str]] = None,
                              zone_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetApiShieldOperationsResult]

func LookupApiShieldOperations(ctx *Context, args *LookupApiShieldOperationsArgs, opts ...InvokeOption) (*LookupApiShieldOperationsResult, error)
func LookupApiShieldOperationsOutput(ctx *Context, args *LookupApiShieldOperationsOutputArgs, opts ...InvokeOption) LookupApiShieldOperationsResultOutput

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

public static class GetApiShieldOperations 
{
    public static Task<GetApiShieldOperationsResult> InvokeAsync(GetApiShieldOperationsArgs args, InvokeOptions? opts = null)
    public static Output<GetApiShieldOperationsResult> Invoke(GetApiShieldOperationsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiShieldOperationsResult> getApiShieldOperations(GetApiShieldOperationsArgs args, InvokeOptions options)
public static Output<GetApiShieldOperationsResult> getApiShieldOperations(GetApiShieldOperationsArgs args, InvokeOptions options)

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

The following arguments are supported:

ZoneId string: Identifier
Direction string: Direction to order results. Available values: "asc", "desc".
Endpoint string: Filter results to only include endpoints containing this pattern.
Features List<string>: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
Hosts List<string>: Filter results to only include the specified hosts.
MaxItems int: Max items to fetch, default: 1000
Methods List<string>: Filter results to only include the specified HTTP methods.
Order string: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".

ZoneId string: Identifier
Direction string: Direction to order results. Available values: "asc", "desc".
Endpoint string: Filter results to only include endpoints containing this pattern.
Features []string: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
Hosts []string: Filter results to only include the specified hosts.
MaxItems int: Max items to fetch, default: 1000
Methods []string: Filter results to only include the specified HTTP methods.
Order string: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".

zoneId String: Identifier
direction String: Direction to order results. Available values: "asc", "desc".
endpoint String: Filter results to only include endpoints containing this pattern.
features List<String>: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
hosts List<String>: Filter results to only include the specified hosts.
maxItems Integer: Max items to fetch, default: 1000
methods List<String>: Filter results to only include the specified HTTP methods.
order String: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".

zoneId string: Identifier
direction string: Direction to order results. Available values: "asc", "desc".
endpoint string: Filter results to only include endpoints containing this pattern.
features string[]: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
hosts string[]: Filter results to only include the specified hosts.
maxItems number: Max items to fetch, default: 1000
methods string[]: Filter results to only include the specified HTTP methods.
order string: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".

zone_id str: Identifier
direction str: Direction to order results. Available values: "asc", "desc".
endpoint str: Filter results to only include endpoints containing this pattern.
features Sequence[str]: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
hosts Sequence[str]: Filter results to only include the specified hosts.
max_items int: Max items to fetch, default: 1000
methods Sequence[str]: Filter results to only include the specified HTTP methods.
order str: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".

zoneId String: Identifier
direction String: Direction to order results. Available values: "asc", "desc".
endpoint String: Filter results to only include endpoints containing this pattern.
features List<String>: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
hosts List<String>: Filter results to only include the specified hosts.
maxItems Number: Max items to fetch, default: 1000
methods List<String>: Filter results to only include the specified HTTP methods.
order String: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".

getApiShieldOperations Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Results List<GetApiShieldOperationsResult>: The items returned by the data source
ZoneId string: Identifier
Direction string: Direction to order results. Available values: "asc", "desc".
Endpoint string: Filter results to only include endpoints containing this pattern.
Features List<string>: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
Hosts List<string>: Filter results to only include the specified hosts.
MaxItems int: Max items to fetch, default: 1000
Methods List<string>: Filter results to only include the specified HTTP methods.
Order string: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".

Id string: The provider-assigned unique ID for this managed resource.
Results []GetApiShieldOperationsResult: The items returned by the data source
ZoneId string: Identifier
Direction string: Direction to order results. Available values: "asc", "desc".
Endpoint string: Filter results to only include endpoints containing this pattern.
Features []string: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
Hosts []string: Filter results to only include the specified hosts.
MaxItems int: Max items to fetch, default: 1000
Methods []string: Filter results to only include the specified HTTP methods.
Order string: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".

id String: The provider-assigned unique ID for this managed resource.
results List<GetApiShieldOperationsResult>: The items returned by the data source
zoneId String: Identifier
direction String: Direction to order results. Available values: "asc", "desc".
endpoint String: Filter results to only include endpoints containing this pattern.
features List<String>: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
hosts List<String>: Filter results to only include the specified hosts.
maxItems Integer: Max items to fetch, default: 1000
methods List<String>: Filter results to only include the specified HTTP methods.
order String: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".

id string: The provider-assigned unique ID for this managed resource.
results GetApiShieldOperationsResult[]: The items returned by the data source
zoneId string: Identifier
direction string: Direction to order results. Available values: "asc", "desc".
endpoint string: Filter results to only include endpoints containing this pattern.
features string[]: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
hosts string[]: Filter results to only include the specified hosts.
maxItems number: Max items to fetch, default: 1000
methods string[]: Filter results to only include the specified HTTP methods.
order string: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".

id str: The provider-assigned unique ID for this managed resource.
results Sequence[GetApiShieldOperationsResult]: The items returned by the data source
zone_id str: Identifier
direction str: Direction to order results. Available values: "asc", "desc".
endpoint str: Filter results to only include endpoints containing this pattern.
features Sequence[str]: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
hosts Sequence[str]: Filter results to only include the specified hosts.
max_items int: Max items to fetch, default: 1000
methods Sequence[str]: Filter results to only include the specified HTTP methods.
order str: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".

id String: The provider-assigned unique ID for this managed resource.
results List<Property Map>: The items returned by the data source
zoneId String: Identifier
direction String: Direction to order results. Available values: "asc", "desc".
endpoint String: Filter results to only include endpoints containing this pattern.
features List<String>: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
hosts List<String>: Filter results to only include the specified hosts.
maxItems Number: Max items to fetch, default: 1000
methods List<String>: Filter results to only include the specified HTTP methods.
order String: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. Available values: "method", "host", "endpoint", "thresholds.$key".

Supporting Types

GetApiShieldOperationsResult

Endpoint string: The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.
Features GetApiShieldOperationsResultFeatures
Host string: RFC3986-compliant host.
LastUpdated string
Method string: The HTTP method used to access the endpoint. Available values: "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "CONNECT", "PATCH", "TRACE".
OperationId string: UUID

Endpoint string: The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.
Features GetApiShieldOperationsResultFeatures
Host string: RFC3986-compliant host.
LastUpdated string
Method string: The HTTP method used to access the endpoint. Available values: "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "CONNECT", "PATCH", "TRACE".
OperationId string: UUID

endpoint String: The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.
features GetApiShieldOperationsResultFeatures
host String: RFC3986-compliant host.
lastUpdated String
method String: The HTTP method used to access the endpoint. Available values: "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "CONNECT", "PATCH", "TRACE".
operationId String: UUID

endpoint string: The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.
features GetApiShieldOperationsResultFeatures
host string: RFC3986-compliant host.
lastUpdated string
method string: The HTTP method used to access the endpoint. Available values: "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "CONNECT", "PATCH", "TRACE".
operationId string: UUID

endpoint str: The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.
features GetApiShieldOperationsResultFeatures
host str: RFC3986-compliant host.
last_updated str
method str: The HTTP method used to access the endpoint. Available values: "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "CONNECT", "PATCH", "TRACE".
operation_id str: UUID

endpoint String: The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.
features Property Map
host String: RFC3986-compliant host.
lastUpdated String
method String: The HTTP method used to access the endpoint. Available values: "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "CONNECT", "PATCH", "TRACE".
operationId String: UUID

GetApiShieldOperationsResultFeatures

ApiRouting GetApiShieldOperationsResultFeaturesApiRouting: API Routing settings on endpoint.
ConfidenceIntervals GetApiShieldOperationsResultFeaturesConfidenceIntervals
ParameterSchemas GetApiShieldOperationsResultFeaturesParameterSchemas
SchemaInfo GetApiShieldOperationsResultFeaturesSchemaInfo
Thresholds GetApiShieldOperationsResultFeaturesThresholds

ApiRouting GetApiShieldOperationsResultFeaturesApiRouting: API Routing settings on endpoint.
ConfidenceIntervals GetApiShieldOperationsResultFeaturesConfidenceIntervals
ParameterSchemas GetApiShieldOperationsResultFeaturesParameterSchemas
SchemaInfo GetApiShieldOperationsResultFeaturesSchemaInfo
Thresholds GetApiShieldOperationsResultFeaturesThresholds

apiRouting GetApiShieldOperationsResultFeaturesApiRouting: API Routing settings on endpoint.
confidenceIntervals GetApiShieldOperationsResultFeaturesConfidenceIntervals
parameterSchemas GetApiShieldOperationsResultFeaturesParameterSchemas
schemaInfo GetApiShieldOperationsResultFeaturesSchemaInfo
thresholds GetApiShieldOperationsResultFeaturesThresholds

apiRouting GetApiShieldOperationsResultFeaturesApiRouting: API Routing settings on endpoint.
confidenceIntervals GetApiShieldOperationsResultFeaturesConfidenceIntervals
parameterSchemas GetApiShieldOperationsResultFeaturesParameterSchemas
schemaInfo GetApiShieldOperationsResultFeaturesSchemaInfo
thresholds GetApiShieldOperationsResultFeaturesThresholds

api_routing GetApiShieldOperationsResultFeaturesApiRouting: API Routing settings on endpoint.
confidence_intervals GetApiShieldOperationsResultFeaturesConfidenceIntervals
parameter_schemas GetApiShieldOperationsResultFeaturesParameterSchemas
schema_info GetApiShieldOperationsResultFeaturesSchemaInfo
thresholds GetApiShieldOperationsResultFeaturesThresholds

apiRouting Property Map: API Routing settings on endpoint.
confidenceIntervals Property Map
parameterSchemas Property Map
schemaInfo Property Map
thresholds Property Map

GetApiShieldOperationsResultFeaturesApiRouting

LastUpdated string
Route string: Target route.

LastUpdated string
Route string: Target route.

lastUpdated String
route String: Target route.

lastUpdated string
route string: Target route.

last_updated str
route str: Target route.

lastUpdated String
route String: Target route.

GetApiShieldOperationsResultFeaturesConfidenceIntervals

LastUpdated string
SuggestedThreshold GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThreshold

LastUpdated string
SuggestedThreshold GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThreshold

lastUpdated String
suggestedThreshold GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThreshold

lastUpdated string
suggestedThreshold GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThreshold

last_updated str
suggested_threshold GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThreshold

lastUpdated String
suggestedThreshold Property Map

GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThreshold

ConfidenceIntervals GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervals
Mean double: Suggested threshold.

ConfidenceIntervals GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervals
Mean float64: Suggested threshold.

confidenceIntervals GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervals
mean Double: Suggested threshold.

confidenceIntervals GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervals
mean number: Suggested threshold.

confidence_intervals GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervals
mean float: Suggested threshold.

confidenceIntervals Property Map
mean Number: Suggested threshold.

GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervals

P90 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90: Upper and lower bound for percentile estimate
P95 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95: Upper and lower bound for percentile estimate
P99 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99: Upper and lower bound for percentile estimate

P90 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90: Upper and lower bound for percentile estimate
P95 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95: Upper and lower bound for percentile estimate
P99 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99: Upper and lower bound for percentile estimate

p90 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90: Upper and lower bound for percentile estimate
p95 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95: Upper and lower bound for percentile estimate
p99 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99: Upper and lower bound for percentile estimate

p90 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90: Upper and lower bound for percentile estimate
p95 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95: Upper and lower bound for percentile estimate
p99 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99: Upper and lower bound for percentile estimate

p90 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90: Upper and lower bound for percentile estimate
p95 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95: Upper and lower bound for percentile estimate
p99 GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99: Upper and lower bound for percentile estimate

p90 Property Map: Upper and lower bound for percentile estimate
p95 Property Map: Upper and lower bound for percentile estimate
p99 Property Map: Upper and lower bound for percentile estimate

GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90

Lower double: Lower bound for percentile estimate
Upper double: Upper bound for percentile estimate

Lower float64: Lower bound for percentile estimate
Upper float64: Upper bound for percentile estimate

lower Double: Lower bound for percentile estimate
upper Double: Upper bound for percentile estimate

lower number: Lower bound for percentile estimate
upper number: Upper bound for percentile estimate

lower float: Lower bound for percentile estimate
upper float: Upper bound for percentile estimate

lower Number: Lower bound for percentile estimate
upper Number: Upper bound for percentile estimate

GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95

Lower double: Lower bound for percentile estimate
Upper double: Upper bound for percentile estimate

Lower float64: Lower bound for percentile estimate
Upper float64: Upper bound for percentile estimate

lower Double: Lower bound for percentile estimate
upper Double: Upper bound for percentile estimate

lower number: Lower bound for percentile estimate
upper number: Upper bound for percentile estimate

lower float: Lower bound for percentile estimate
upper float: Upper bound for percentile estimate

lower Number: Lower bound for percentile estimate
upper Number: Upper bound for percentile estimate

GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99

Lower double: Lower bound for percentile estimate
Upper double: Upper bound for percentile estimate

Lower float64: Lower bound for percentile estimate
Upper float64: Upper bound for percentile estimate

lower Double: Lower bound for percentile estimate
upper Double: Upper bound for percentile estimate

lower number: Lower bound for percentile estimate
upper number: Upper bound for percentile estimate

lower float: Lower bound for percentile estimate
upper float: Upper bound for percentile estimate

lower Number: Lower bound for percentile estimate
upper Number: Upper bound for percentile estimate

GetApiShieldOperationsResultFeaturesParameterSchemas

LastUpdated string
ParameterSchemas GetApiShieldOperationsResultFeaturesParameterSchemasParameterSchemas: An operation schema object containing a response.

LastUpdated string
ParameterSchemas GetApiShieldOperationsResultFeaturesParameterSchemasParameterSchemas: An operation schema object containing a response.

lastUpdated String
parameterSchemas GetApiShieldOperationsResultFeaturesParameterSchemasParameterSchemas: An operation schema object containing a response.

lastUpdated string
parameterSchemas GetApiShieldOperationsResultFeaturesParameterSchemasParameterSchemas: An operation schema object containing a response.

last_updated str
parameter_schemas GetApiShieldOperationsResultFeaturesParameterSchemasParameterSchemas: An operation schema object containing a response.

lastUpdated String
parameterSchemas Property Map: An operation schema object containing a response.

GetApiShieldOperationsResultFeaturesParameterSchemasParameterSchemas

Parameters List<string>: An array containing the learned parameter schemas.
Responses string: An empty response object. This field is required to yield a valid operation schema.

Parameters []string: An array containing the learned parameter schemas.
Responses string: An empty response object. This field is required to yield a valid operation schema.

parameters List<String>: An array containing the learned parameter schemas.
responses String: An empty response object. This field is required to yield a valid operation schema.

parameters string[]: An array containing the learned parameter schemas.
responses string: An empty response object. This field is required to yield a valid operation schema.

parameters Sequence[str]: An array containing the learned parameter schemas.
responses str: An empty response object. This field is required to yield a valid operation schema.

parameters List<String>: An array containing the learned parameter schemas.
responses String: An empty response object. This field is required to yield a valid operation schema.

GetApiShieldOperationsResultFeaturesSchemaInfo

ActiveSchema GetApiShieldOperationsResultFeaturesSchemaInfoActiveSchema: Schema active on endpoint.
LearnedAvailable bool: True if a Cloudflare-provided learned schema is available for this endpoint.
MitigationAction string: Action taken on requests failing validation. Available values: "none", "log", "block".

ActiveSchema GetApiShieldOperationsResultFeaturesSchemaInfoActiveSchema: Schema active on endpoint.
LearnedAvailable bool: True if a Cloudflare-provided learned schema is available for this endpoint.
MitigationAction string: Action taken on requests failing validation. Available values: "none", "log", "block".

activeSchema GetApiShieldOperationsResultFeaturesSchemaInfoActiveSchema: Schema active on endpoint.
learnedAvailable Boolean: True if a Cloudflare-provided learned schema is available for this endpoint.
mitigationAction String: Action taken on requests failing validation. Available values: "none", "log", "block".

activeSchema GetApiShieldOperationsResultFeaturesSchemaInfoActiveSchema: Schema active on endpoint.
learnedAvailable boolean: True if a Cloudflare-provided learned schema is available for this endpoint.
mitigationAction string: Action taken on requests failing validation. Available values: "none", "log", "block".

active_schema GetApiShieldOperationsResultFeaturesSchemaInfoActiveSchema: Schema active on endpoint.
learned_available bool: True if a Cloudflare-provided learned schema is available for this endpoint.
mitigation_action str: Action taken on requests failing validation. Available values: "none", "log", "block".

activeSchema Property Map: Schema active on endpoint.
learnedAvailable Boolean: True if a Cloudflare-provided learned schema is available for this endpoint.
mitigationAction String: Action taken on requests failing validation. Available values: "none", "log", "block".

GetApiShieldOperationsResultFeaturesSchemaInfoActiveSchema

CreatedAt string
Id string: UUID
IsLearned bool: True if schema is Cloudflare-provided.
Name string: Schema file name.

CreatedAt string
Id string: UUID
IsLearned bool: True if schema is Cloudflare-provided.
Name string: Schema file name.

createdAt String
id String: UUID
isLearned Boolean: True if schema is Cloudflare-provided.
name String: Schema file name.

createdAt string
id string: UUID
isLearned boolean: True if schema is Cloudflare-provided.
name string: Schema file name.

created_at str
id str: UUID
is_learned bool: True if schema is Cloudflare-provided.
name str: Schema file name.

createdAt String
id String: UUID
isLearned Boolean: True if schema is Cloudflare-provided.
name String: Schema file name.

GetApiShieldOperationsResultFeaturesThresholds

AuthIdTokens int: The total number of auth-ids seen across this calculation.
DataPoints int: The number of data points used for the threshold suggestion calculation.
LastUpdated string
P50 int: The p50 quantile of requests (in period_seconds).
P90 int: The p90 quantile of requests (in period_seconds).
P99 int: The p99 quantile of requests (in period_seconds).
PeriodSeconds int: The period over which this threshold is suggested.
Requests int: The estimated number of requests covered by these calculations.
SuggestedThreshold int: The suggested threshold in requests done by the same authid or periodseconds.

AuthIdTokens int: The total number of auth-ids seen across this calculation.
DataPoints int: The number of data points used for the threshold suggestion calculation.
LastUpdated string
P50 int: The p50 quantile of requests (in period_seconds).
P90 int: The p90 quantile of requests (in period_seconds).
P99 int: The p99 quantile of requests (in period_seconds).
PeriodSeconds int: The period over which this threshold is suggested.
Requests int: The estimated number of requests covered by these calculations.
SuggestedThreshold int: The suggested threshold in requests done by the same authid or periodseconds.

authIdTokens Integer: The total number of auth-ids seen across this calculation.
dataPoints Integer: The number of data points used for the threshold suggestion calculation.
lastUpdated String
p50 Integer: The p50 quantile of requests (in period_seconds).
p90 Integer: The p90 quantile of requests (in period_seconds).
p99 Integer: The p99 quantile of requests (in period_seconds).
periodSeconds Integer: The period over which this threshold is suggested.
requests Integer: The estimated number of requests covered by these calculations.
suggestedThreshold Integer: The suggested threshold in requests done by the same authid or periodseconds.

authIdTokens number: The total number of auth-ids seen across this calculation.
dataPoints number: The number of data points used for the threshold suggestion calculation.
lastUpdated string
p50 number: The p50 quantile of requests (in period_seconds).
p90 number: The p90 quantile of requests (in period_seconds).
p99 number: The p99 quantile of requests (in period_seconds).
periodSeconds number: The period over which this threshold is suggested.
requests number: The estimated number of requests covered by these calculations.
suggestedThreshold number: The suggested threshold in requests done by the same authid or periodseconds.

auth_id_tokens int: The total number of auth-ids seen across this calculation.
data_points int: The number of data points used for the threshold suggestion calculation.
last_updated str
p50 int: The p50 quantile of requests (in period_seconds).
p90 int: The p90 quantile of requests (in period_seconds).
p99 int: The p99 quantile of requests (in period_seconds).
period_seconds int: The period over which this threshold is suggested.
requests int: The estimated number of requests covered by these calculations.
suggested_threshold int: The suggested threshold in requests done by the same authid or periodseconds.

authIdTokens Number: The total number of auth-ids seen across this calculation.
dataPoints Number: The number of data points used for the threshold suggestion calculation.
lastUpdated String
p50 Number: The p50 quantile of requests (in period_seconds).
p90 Number: The p90 quantile of requests (in period_seconds).
p99 Number: The p99 quantile of requests (in period_seconds).
periodSeconds Number: The period over which this threshold is suggested.
requests Number: The estimated number of requests covered by these calculations.
suggestedThreshold Number: The suggested threshold in requests done by the same authid or periodseconds.

Package Details

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

Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getApiShieldOperations

On this page

On this page

Example Usage

Using getApiShieldOperations

getApiShieldOperations Result

Supporting Types

GetApiShieldOperationsResult

GetApiShieldOperationsResultFeatures

GetApiShieldOperationsResultFeaturesApiRouting

GetApiShieldOperationsResultFeaturesConfidenceIntervals

GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThreshold

GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervals

GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90

GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95

GetApiShieldOperationsResultFeaturesConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99

GetApiShieldOperationsResultFeaturesParameterSchemas

GetApiShieldOperationsResultFeaturesParameterSchemasParameterSchemas

GetApiShieldOperationsResultFeaturesSchemaInfo

GetApiShieldOperationsResultFeaturesSchemaInfoActiveSchema

GetApiShieldOperationsResultFeaturesThresholds

Package Details

On this page

On this page