Skip to content
Cloudflare API
Start here
API Reference

Schema Validation

Schema ValidationSchemas

List all uploaded schemas
GET/zones/{zone_id}/schema_validation/schemas
Get details of a schema
GET/zones/{zone_id}/schema_validation/schemas/{schema_id}
Upload a schema
POST/zones/{zone_id}/schema_validation/schemas
Edit details of a schema to enable validation
PATCH/zones/{zone_id}/schema_validation/schemas/{schema_id}
Delete a schema
DELETE/zones/{zone_id}/schema_validation/schemas/{schema_id}
ModelsExpand Collapse
PublicSchema { created_at, kind, name, 3 more }

A schema used in schema validation

created_at: string
formatdate-time
kind: "openapi_v3"

The kind of the schema

name: string

A human-readable name for the schema

schema_id: string

A unique identifier of this schema

maxLength36
minLength36
formatuuid
source: string

The raw schema, e.g., the OpenAPI schema, either as JSON or YAML

validation_enabled: optional boolean

An indicator if this schema is enabled

SchemaDeleteResponse { id }
id: string

The ID of the schema that was just deleted

formatuuid

Schema ValidationSettings

Get global schema validation settings
GET/zones/{zone_id}/schema_validation/settings
Update global schema validation settings
PUT/zones/{zone_id}/schema_validation/settings
Edit global schema validation settings
PATCH/zones/{zone_id}/schema_validation/settings
ModelsExpand Collapse
SettingGetResponse { validation_default_mitigation_action, validation_override_mitigation_action }
validation_default_mitigation_action: "none" or "log" or "block"

The default mitigation action used

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
  • none - skip running schema validation
One of the following:
"none"
"log"
"block"
validation_override_mitigation_action: optional "none"

When not null, this overrides global both zone level and operation level mitigation actions. This can serve as a quick way to disable schema validation for the whole zone.

  • "none" will skip running schema validation entirely for the request
SettingUpdateResponse { validation_default_mitigation_action, validation_override_mitigation_action }
validation_default_mitigation_action: "none" or "log" or "block"

The default mitigation action used

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
  • none - skip running schema validation
One of the following:
"none"
"log"
"block"
validation_override_mitigation_action: optional "none"

When not null, this overrides global both zone level and operation level mitigation actions. This can serve as a quick way to disable schema validation for the whole zone.

  • "none" will skip running schema validation entirely for the request
SettingEditResponse { validation_default_mitigation_action, validation_override_mitigation_action }
validation_default_mitigation_action: "none" or "log" or "block"

The default mitigation action used

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
  • none - skip running schema validation
One of the following:
"none"
"log"
"block"
validation_override_mitigation_action: optional "none"

When not null, this overrides global both zone level and operation level mitigation actions. This can serve as a quick way to disable schema validation for the whole zone.

  • "none" will skip running schema validation entirely for the request

Schema ValidationSettingsOperations

List per-operation schema validation settings
GET/zones/{zone_id}/schema_validation/settings/operations
Get per-operation schema validation setting
GET/zones/{zone_id}/schema_validation/settings/operations/{operation_id}
Update per-operation schema validation setting
PUT/zones/{zone_id}/schema_validation/settings/operations/{operation_id}
Bulk edit per-operation schema validation settings
PATCH/zones/{zone_id}/schema_validation/settings/operations
Delete per-operation schema validation setting
DELETE/zones/{zone_id}/schema_validation/settings/operations/{operation_id}
ModelsExpand Collapse
OperationListResponse { mitigation_action, operation_id }
mitigation_action: "log" or "block" or "none"

When set, this applies a mitigation action to this operation which supersedes a global schema validation setting just for 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
One of the following:
"log"
"block"
"none"
operation_id: string

UUID.

maxLength36
minLength36
OperationGetResponse { mitigation_action, operation_id }
mitigation_action: "log" or "block" or "none"

When set, this applies a mitigation action to this operation which supersedes a global schema validation setting just for 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
One of the following:
"log"
"block"
"none"
operation_id: string

UUID.

maxLength36
minLength36
OperationUpdateResponse { mitigation_action, operation_id }
mitigation_action: "log" or "block" or "none"

When set, this applies a mitigation action to this operation which supersedes a global schema validation setting just for 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
One of the following:
"log"
"block"
"none"
operation_id: string

UUID.

maxLength36
minLength36
OperationBulkEditResponse = map[ { mitigation_action, operation_id } ]

Operation ID to per operation setting mapping

mitigation_action: "log" or "block" or "none"

When set, this applies a mitigation action to this operation which supersedes a global schema validation setting just for 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
One of the following:
"log"
"block"
"none"
operation_id: string

UUID.

maxLength36
minLength36
OperationDeleteResponse { operation_id }
operation_id: optional string

UUID.

maxLength36
minLength36