terraform-provider-cloudflare/docs/resources/api_shield_operation.md

page_title	subcategory	description
cloudflare_api_shield_operation Resource - Cloudflare

cloudflare_api_shield_operation (Resource)

Example Usage

resource "cloudflare_api_shield_operation" "example_api_shield_operation" {
  zone_id = "zone_id"
  endpoint = "/api/v1/users/{var1}"
  host = "www.example.com"
  method = "GET"
}

Schema

Required

• 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/.
• host (String) RFC3986-compliant host.
• method (String) The HTTP method used to access the endpoint.
• zone_id (String)

Read-Only

• features (Attributes) (see below for nested schema)
• id (String) The ID of this resource.
• last_updated (String)
• operation_id (String)

Nested Schema for features

Read-Only:

• api_routing (Attributes) API Routing settings on endpoint. (see below for nested schema)
• confidence_intervals (Attributes) (see below for nested schema)
• parameter_schemas (Attributes) (see below for nested schema)
• schema_info (Attributes) (see below for nested schema)
• thresholds (Attributes) (see below for nested schema)

Nested Schema for features.api_routing

Read-Only:

• last_updated (String)
• route (String) Target route.

Nested Schema for features.confidence_intervals

Read-Only:

• last_updated (String)
• suggested_threshold (Attributes) (see below for nested schema)

Nested Schema for features.confidence_intervals.suggested_threshold

Read-Only:

• confidence_intervals (Attributes) (see below for nested schema)
• mean (Number) Suggested threshold.

Nested Schema for features.confidence_intervals.suggested_threshold.confidence_intervals

Read-Only:

• p90 (Attributes) Upper and lower bound for percentile estimate (see below for nested schema)
• p95 (Attributes) Upper and lower bound for percentile estimate (see below for nested schema)
• p99 (Attributes) Upper and lower bound for percentile estimate (see below for nested schema)

Nested Schema for features.confidence_intervals.suggested_threshold.confidence_intervals.p90

Read-Only:

• lower (Number) Lower bound for percentile estimate
• upper (Number) Upper bound for percentile estimate

Nested Schema for features.confidence_intervals.suggested_threshold.confidence_intervals.p95

Read-Only:

• lower (Number) Lower bound for percentile estimate
• upper (Number) Upper bound for percentile estimate

Nested Schema for features.confidence_intervals.suggested_threshold.confidence_intervals.p99

Read-Only:

• lower (Number) Lower bound for percentile estimate
• upper (Number) Upper bound for percentile estimate

Nested Schema for features.parameter_schemas

Read-Only:

• last_updated (String)
• parameter_schemas (Attributes) An operation schema object containing a response. (see below for nested schema)

Nested Schema for features.parameter_schemas.parameter_schemas

Read-Only:

• parameters (List of String) An array containing the learned parameter schemas.
• responses (String) An empty response object. This field is required to yield a valid operation schema.

Nested Schema for features.schema_info

Read-Only:

• active_schema (Attributes) Schema active on endpoint. (see below for nested schema)
• learned_available (Boolean) True if a Cloudflare-provided learned schema is available for this endpoint.
• mitigation_action (String) Action taken on requests failing validation.

Nested Schema for features.schema_info.active_schema

Read-Only:

• created_at (String)
• id (String)
• is_learned (Boolean) True if schema is Cloudflare-provided.
• name (String) Schema file name.

Nested Schema for features.thresholds

Read-Only:

• auth_id_tokens (Number) The total number of auth-ids seen across this calculation.
• data_points (Number) The number of data points used for the threshold suggestion calculation.
• last_updated (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).
• period_seconds (Number) The period over which this threshold is suggested.
• requests (Number) The estimated number of requests covered by these calculations.
• suggested_threshold (Number) The suggested threshold in requests done by the same auth_id or period_seconds.

Import

Import is supported using the following syntax:

$ terraform import cloudflare_api_shield_operation.example '<zone_id>/<operation_id>'