LogoCloudflare API

Schema Validation

SchemaValidation

Schema Validation

Schemas

SchemaValidation.Schemas

Methods

list(, ):
V4PagePaginationArray
<
PublicSchema
>
get/zones/{zone_id}/schema_validation/schemas

Lists all OpenAPI schemas uploaded to API Shield with pagination support.

get(, , ):
PublicSchema
get/zones/{zone_id}/schema_validation/schemas/{schema_id}

Gets the contents and metadata of a specific OpenAPI schema uploaded to API Shield.

create(, ):
PublicSchema
post/zones/{zone_id}/schema_validation/schemas

Uploads a new OpenAPI schema for API Shield schema validation. The schema defines expected request/response formats for API endpoints.

edit(, , ):
PublicSchema
patch/zones/{zone_id}/schema_validation/schemas/{schema_id}

Modifies an existing OpenAPI schema in API Shield, updating the validation rules for associated API operations.

delete(, , ):
SchemaDeleteResponse
delete/zones/{zone_id}/schema_validation/schemas/{schema_id}

Permanently removes an uploaded OpenAPI schema from API Shield. Operations using this schema will lose their validation rules.

Domain types

PublicSchema{…}

A schema used in schema validation

Schema Validation

Settings

SchemaValidation.Settings

Methods

get(, ):
SettingGetResponse
get/zones/{zone_id}/schema_validation/settings

Retrieves the current global schema validation settings for a zone.

update(, ):
SettingUpdateResponse
put/zones/{zone_id}/schema_validation/settings

Fully updates global schema validation settings for a zone, replacing existing configuration.

edit(, ):
SettingEditResponse
patch/zones/{zone_id}/schema_validation/settings

Partially updates global schema validation settings for a zone using PATCH semantics.

Schema ValidationSettings

Operations

SchemaValidation.Settings.Operations

Methods

list(, ):
V4PagePaginationArray
<
OperationListResponse
>
get/zones/{zone_id}/schema_validation/settings/operations

Lists all per-operation schema validation settings configured for the zone.

get(, , ):
OperationGetResponse
get/zones/{zone_id}/schema_validation/settings/operations/{operation_id}

Retrieves the schema validation settings configured for a specific API operation.

update(, , ):
OperationUpdateResponse
put/zones/{zone_id}/schema_validation/settings/operations/{operation_id}

Fully updates schema validation settings for a specific API operation.

bulkEdit(, ):
OperationBulkEditResponse
patch/zones/{zone_id}/schema_validation/settings/operations

Updates schema validation settings for multiple API operations in a single request. Efficient for applying consistent validation rules across endpoints.

delete(, , ):
OperationDeleteResponse
delete/zones/{zone_id}/schema_validation/settings/operations/{operation_id}

Removes custom schema validation settings for a specific API operation, reverting to zone-level defaults.