Skip to content
Cloudflare API
Start here
API Reference

Schema Validation

Schema ValidationSchemas

List all uploaded schemas
client.SchemaValidation.Schemas.List(ctx, params) (*V4PagePaginationArray[PublicSchema], error)
GET/zones/{zone_id}/schema_validation/schemas
Get details of a schema
client.SchemaValidation.Schemas.Get(ctx, schemaID, params) (*PublicSchema, error)
GET/zones/{zone_id}/schema_validation/schemas/{schema_id}
Upload a schema
client.SchemaValidation.Schemas.New(ctx, params) (*PublicSchema, error)
POST/zones/{zone_id}/schema_validation/schemas
Edit details of a schema to enable validation
client.SchemaValidation.Schemas.Edit(ctx, schemaID, params) (*PublicSchema, error)
PATCH/zones/{zone_id}/schema_validation/schemas/{schema_id}
Delete a schema
client.SchemaValidation.Schemas.Delete(ctx, schemaID, body) (*SchemaDeleteResponse, error)
DELETE/zones/{zone_id}/schema_validation/schemas/{schema_id}
ModelsExpand Collapse
type PublicSchema struct{…}

A schema used in schema validation

CreatedAt Time
formatdate-time
Kind PublicSchemaKind

The kind of the schema

Name string

A human-readable name for the schema

SchemaID 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

ValidationEnabled booloptional

An indicator if this schema is enabled

Schema ValidationSettings

Get global schema validation settings
client.SchemaValidation.Settings.Get(ctx, query) (*SettingGetResponse, error)
GET/zones/{zone_id}/schema_validation/settings
Update global schema validation settings
client.SchemaValidation.Settings.Update(ctx, params) (*SettingUpdateResponse, error)
PUT/zones/{zone_id}/schema_validation/settings
Edit global schema validation settings
client.SchemaValidation.Settings.Edit(ctx, params) (*SettingEditResponse, error)
PATCH/zones/{zone_id}/schema_validation/settings

Schema ValidationSettingsOperations

List per-operation schema validation settings
client.SchemaValidation.Settings.Operations.List(ctx, params) (*V4PagePaginationArray[SettingOperationListResponse], error)
GET/zones/{zone_id}/schema_validation/settings/operations
Get per-operation schema validation setting
client.SchemaValidation.Settings.Operations.Get(ctx, operationID, query) (*SettingOperationGetResponse, error)
GET/zones/{zone_id}/schema_validation/settings/operations/{operation_id}
Update per-operation schema validation setting
client.SchemaValidation.Settings.Operations.Update(ctx, operationID, params) (*SettingOperationUpdateResponse, error)
PUT/zones/{zone_id}/schema_validation/settings/operations/{operation_id}
Bulk edit per-operation schema validation settings
client.SchemaValidation.Settings.Operations.BulkEdit(ctx, params) (*SettingOperationBulkEditResponse, error)
PATCH/zones/{zone_id}/schema_validation/settings/operations
Delete per-operation schema validation setting
client.SchemaValidation.Settings.Operations.Delete(ctx, operationID, body) (*SettingOperationDeleteResponse, error)
DELETE/zones/{zone_id}/schema_validation/settings/operations/{operation_id}