Skip to content
Start here

Schemas

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