Skip to content
Cloudflare API
Start here
API Reference
API Gateway

Settings

SettingsSchema Validation

resource cloudflare_api_shield_schema_validation_settings

required Expand Collapse
zone_id: String

Identifier.

validation_default_mitigation_action: String

The default mitigation action used when there is no mitigation action defined on the operation

Mitigation actions are as follows:

  • log - log request when request does not conform to schema
  • block - deny access to the site when request does not conform to schema

A special value of of none will skip running schema validation entirely for the request when there is no mitigation action defined on the operation

optional Expand Collapse
validation_override_mitigation_action?: String

When set, this overrides both zone level and operation level mitigation actions.

  • none will skip running schema validation entirely for the request
  • null indicates that no override is in place

To clear any override, use the special value disable_override or null

computed Expand Collapse
id: String

Identifier.

cloudflare_api_shield_schema_validation_settings

resource "cloudflare_api_shield_schema_validation_settings" "example_api_shield_schema_validation_settings" {
  zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
  validation_default_mitigation_action = "block"
  validation_override_mitigation_action = "none"
}

data cloudflare_api_shield_schema_validation_settings

required Expand Collapse
zone_id: String

Identifier.

computed Expand Collapse
id: String

Identifier.

validation_default_mitigation_action: String

The default mitigation action used when there is no mitigation action defined on the operation

Mitigation actions are as follows:

  • log - log request when request does not conform to schema
  • block - deny access to the site when request does not conform to schema

A special value of of none will skip running schema validation entirely for the request when there is no mitigation action defined on the operation

validation_override_mitigation_action: String

When set, this overrides both zone level and operation level mitigation actions.

  • none will skip running schema validation entirely for the request
  • null indicates that no override is in place

cloudflare_api_shield_schema_validation_settings

data "cloudflare_api_shield_schema_validation_settings" "example_api_shield_schema_validation_settings" {
  zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
}