--- title: Schema Validation --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Schema Validation #### Schema ValidationSchemas ##### [List all uploaded schemas](https://developers.cloudflare.com/api/python/resources/schema_validation/subresources/schemas/methods/list) schema\_validation.schemas.list(SchemaListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[PublicSchema]()] GET/zones/{zone\_id}/schema\_validation/schemas ##### [Get details of a schema](https://developers.cloudflare.com/api/python/resources/schema_validation/subresources/schemas/methods/get) schema\_validation.schemas.get(strschema\_id, SchemaGetParams\*\*kwargs) -> [PublicSchema]() GET/zones/{zone\_id}/schema\_validation/schemas/{schema\_id} ##### [Upload a schema](https://developers.cloudflare.com/api/python/resources/schema_validation/subresources/schemas/methods/create) schema\_validation.schemas.create(SchemaCreateParams\*\*kwargs) -> [PublicSchema]() POST/zones/{zone\_id}/schema\_validation/schemas ##### [Set schema validation state](https://developers.cloudflare.com/api/python/resources/schema_validation/subresources/schemas/methods/edit) schema\_validation.schemas.edit(strschema\_id, SchemaEditParams\*\*kwargs) -> [PublicSchema]() PATCH/zones/{zone\_id}/schema\_validation/schemas/{schema\_id} ##### [Delete a schema](https://developers.cloudflare.com/api/python/resources/schema_validation/subresources/schemas/methods/delete) schema\_validation.schemas.delete(strschema\_id, SchemaDeleteParams\*\*kwargs) -> object DELETE/zones/{zone\_id}/schema\_validation/schemas/{schema\_id} ##### ModelsExpand Collapse
class PublicSchema: … A schema used in schema validation created\_at: datetime formatdate-time Link to this property kind: Literal\["openapi\_v3"] The kind of the schema Link to this property name: str A human-readable name for the schema Link to this property schema\_id: str A unique identifier of this schema maxLength36 minLength36 formatuuid Link to this property source: str The raw schema, e.g., the OpenAPI schema, either as JSON or YAML Link to this property validation\_enabled: Optional\[bool] An indicator if this schema is enabled Link to this property
[Link to this property](<#(resource)%20schema_validation.schemas%20%3E%20(model)%20public_schema%20%3E%20(schema)>) #### Schema ValidationSettings ##### [Get global schema validation settings](https://developers.cloudflare.com/api/python/resources/schema_validation/subresources/settings/methods/get) schema\_validation.settings.get(SettingGetParams\*\*kwargs) -> [SettingGetResponse]() GET/zones/{zone\_id}/schema\_validation/settings ##### [Update global schema validation settings](https://developers.cloudflare.com/api/python/resources/schema_validation/subresources/settings/methods/update) schema\_validation.settings.update(SettingUpdateParams\*\*kwargs) -> [SettingUpdateResponse]() PUT/zones/{zone\_id}/schema\_validation/settings ##### [Edit global schema validation settings](https://developers.cloudflare.com/api/python/resources/schema_validation/subresources/settings/methods/edit) schema\_validation.settings.edit(SettingEditParams\*\*kwargs) -> [SettingEditResponse]() PATCH/zones/{zone\_id}/schema\_validation/settings ##### ModelsExpand Collapse
class SettingGetResponse: …
validation\_default\_mitigation\_action: Literal\["none", "log", "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" Link to this property "log" Link to this property "block" Link to this property
Link to this property validation\_override\_mitigation\_action: Optional\[Literal\["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 Link to this property
[Link to this property](<#(resource)%20schema_validation.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)>)
class SettingUpdateResponse: …
validation\_default\_mitigation\_action: Literal\["none", "log", "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" Link to this property "log" Link to this property "block" Link to this property
Link to this property validation\_override\_mitigation\_action: Optional\[Literal\["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 Link to this property
[Link to this property](<#(resource)%20schema_validation.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)>)
class SettingEditResponse: …
validation\_default\_mitigation\_action: Literal\["none", "log", "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" Link to this property "log" Link to this property "block" Link to this property
Link to this property validation\_override\_mitigation\_action: Optional\[Literal\["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 Link to this property
[Link to this property](<#(resource)%20schema_validation.settings%20%3E%20(model)%20setting_edit_response%20%3E%20(schema)>) #### Schema ValidationSettingsOperations ##### [List per-operation schema validation settings](https://developers.cloudflare.com/api/python/resources/schema_validation/subresources/settings/subresources/operations/methods/list) schema\_validation.settings.operations.list(OperationListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[OperationListResponse]()] GET/zones/{zone\_id}/schema\_validation/settings/operations ##### [Get per-operation schema validation setting](https://developers.cloudflare.com/api/python/resources/schema_validation/subresources/settings/subresources/operations/methods/get) schema\_validation.settings.operations.get(stroperation\_id, OperationGetParams\*\*kwargs) -> [OperationGetResponse]() GET/zones/{zone\_id}/schema\_validation/settings/operations/{operation\_id} ##### [Update per-operation schema validation setting](https://developers.cloudflare.com/api/python/resources/schema_validation/subresources/settings/subresources/operations/methods/update) schema\_validation.settings.operations.update(stroperation\_id, OperationUpdateParams\*\*kwargs) -> [OperationUpdateResponse]() PUT/zones/{zone\_id}/schema\_validation/settings/operations/{operation\_id} ##### [Bulk edit per-operation schema validation settings](https://developers.cloudflare.com/api/python/resources/schema_validation/subresources/settings/subresources/operations/methods/bulk_edit) schema\_validation.settings.operations.bulk\_edit(OperationBulkEditParams\*\*kwargs) -> [OperationBulkEditResponse]() PATCH/zones/{zone\_id}/schema\_validation/settings/operations ##### [Delete per-operation schema validation setting](https://developers.cloudflare.com/api/python/resources/schema_validation/subresources/settings/subresources/operations/methods/delete) schema\_validation.settings.operations.delete(stroperation\_id, OperationDeleteParams\*\*kwargs) -> [OperationDeleteResponse]() DELETE/zones/{zone\_id}/schema\_validation/settings/operations/{operation\_id} ##### ModelsExpand Collapse
class OperationListResponse: …
mitigation\_action: Literal\["log", "block", "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" Link to this property "block" Link to this property "none" Link to this property
Link to this property operation\_id: str UUID. maxLength36 minLength36 Link to this property
[Link to this property](<#(resource)%20schema_validation.settings.operations%20%3E%20(model)%20operation_list_response%20%3E%20(schema)>)
class OperationGetResponse: …
mitigation\_action: Literal\["log", "block", "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" Link to this property "block" Link to this property "none" Link to this property
Link to this property operation\_id: str UUID. maxLength36 minLength36 Link to this property
[Link to this property](<#(resource)%20schema_validation.settings.operations%20%3E%20(model)%20operation_get_response%20%3E%20(schema)>)
class OperationUpdateResponse: …
mitigation\_action: Literal\["log", "block", "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" Link to this property "block" Link to this property "none" Link to this property
Link to this property operation\_id: str UUID. maxLength36 minLength36 Link to this property
[Link to this property](<#(resource)%20schema_validation.settings.operations%20%3E%20(model)%20operation_update_response%20%3E%20(schema)>)
Dict\[str, OperationBulkEditResponseItem] Operation ID to updated mitigation action mapping
mitigation\_action: Optional\[Literal\["log", "block", "none"]] 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 - clears any mitigation action One of the following: "log" Link to this property "block" Link to this property "none" Link to this property
Link to this property
[Link to this property](<#(resource)%20schema_validation.settings.operations%20%3E%20(model)%20operation_bulk_edit_response%20%3E%20(schema)>)
class OperationDeleteResponse: … operation\_id: Optional\[str] UUID. maxLength36 minLength36 Link to this property
[Link to this property](<#(resource)%20schema_validation.settings.operations%20%3E%20(model)%20operation_delete_response%20%3E%20(schema)>)