Skip to content
Cloudflare API
Start here
API Reference
API Gateway

Settings

ModelsExpand Collapse
type Settings struct{…}
ValidationDefaultMitigationAction SettingsValidationDefaultMitigationActionoptional

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:
const SettingsValidationDefaultMitigationActionNone SettingsValidationDefaultMitigationAction = "none"
const SettingsValidationDefaultMitigationActionLog SettingsValidationDefaultMitigationAction = "log"
const SettingsValidationDefaultMitigationActionBlock SettingsValidationDefaultMitigationAction = "block"
ValidationOverrideMitigationAction SettingsValidationOverrideMitigationActionoptional

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(ctx, query) (*Settings, error)
GET/zones/{zone_id}/api_gateway/settings/schema_validation
Update zone level schema validation settings
Deprecated
client.APIGateway.Settings.SchemaValidation.Update(ctx, params) (*Settings, error)
PUT/zones/{zone_id}/api_gateway/settings/schema_validation
Update zone level schema validation settings
Deprecated
client.APIGateway.Settings.SchemaValidation.Edit(ctx, params) (*Settings, error)
PATCH/zones/{zone_id}/api_gateway/settings/schema_validation