Skip to content
Cloudflare API
Start here
API Reference
API Gateway
Operations

Schema Validation

Retrieve operation-level schema validation settings
Deprecated
client.apiGateway.operations.schemaValidation.get(stringoperationId, SchemaValidationGetParams { zone_id } params, RequestOptionsoptions?): SchemaValidationGetResponse { mitigation_action, operation_id }
GET/zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation
Update operation-level schema validation settings
Deprecated
client.apiGateway.operations.schemaValidation.update(stringoperationId, SchemaValidationUpdateParams { zone_id, mitigation_action } params, RequestOptionsoptions?): SchemaValidationUpdateResponse { mitigation_action, operation_id }
PUT/zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation
Update multiple operation-level schema validation settings
Deprecated
client.apiGateway.operations.schemaValidation.edit(SchemaValidationEditParams { zone_id, settings_multiple_request } params, RequestOptionsoptions?): SettingsMultipleRequest { mitigation_action }
PATCH/zones/{zone_id}/api_gateway/operations/schema_validation
ModelsExpand Collapse
SettingsMultipleRequest = Record<string, item>
mitigation_action?: "log" | "block" | "none" | null

When set, this applies a mitigation action to this operation

  • log log request when request does not conform to schema for this operation
  • block deny access to the site when request does not conform to schema for this operation
  • none will skip mitigation for this operation
  • null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied
One of the following:
"log"
"block"
"none"
SchemaValidationGetResponse { mitigation_action, operation_id }
mitigation_action?: "log" | "block" | "none" | null

When set, this applies a mitigation action to this operation

  • log log request when request does not conform to schema for this operation
  • block deny access to the site when request does not conform to schema for this operation
  • none will skip mitigation for this operation
  • null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied
One of the following:
"log"
"block"
"none"
operation_id?: string

UUID.

maxLength36
minLength36
SchemaValidationUpdateResponse { mitigation_action, operation_id }
mitigation_action?: "log" | "block" | "none" | null

When set, this applies a mitigation action to this operation

  • log log request when request does not conform to schema for this operation
  • block deny access to the site when request does not conform to schema for this operation
  • none will skip mitigation for this operation
  • null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied
One of the following:
"log"
"block"
"none"
operation_id?: string

UUID.

maxLength36
minLength36