Skip to content
Cloudflare API
Start here
API Reference
API Gateway

Settings

ModelsExpand Collapse
Settings { validation_default_mitigation_action, validation_override_mitigation_action }
validation_default_mitigation_action?: "none" | "log" | "block"

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

One of the following:
"none"
"log"
"block"
validation_override_mitigation_action?: "none" | null

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

SettingsSchema Validation

Retrieve zone level schema validation settings
Deprecated
client.apiGateway.settings.schemaValidation.get(SchemaValidationGetParams { zone_id } params, RequestOptionsoptions?): Settings { validation_default_mitigation_action, validation_override_mitigation_action }
GET/zones/{zone_id}/api_gateway/settings/schema_validation
Update zone level schema validation settings
Deprecated
client.apiGateway.settings.schemaValidation.update(SchemaValidationUpdateParams { zone_id, validation_default_mitigation_action, validation_override_mitigation_action } params, RequestOptionsoptions?): Settings { validation_default_mitigation_action, validation_override_mitigation_action }
PUT/zones/{zone_id}/api_gateway/settings/schema_validation
Update zone level schema validation settings
Deprecated
client.apiGateway.settings.schemaValidation.edit(SchemaValidationEditParams { zone_id, validation_default_mitigation_action, validation_override_mitigation_action } params, RequestOptionsoptions?): Settings { validation_default_mitigation_action, validation_override_mitigation_action }
PATCH/zones/{zone_id}/api_gateway/settings/schema_validation