API Reference

Schema Validation

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Schemas

List all uploaded schemas

schema_validation.schemas.list(SchemaListParams**kwargs) -> SyncV4PagePaginationArray[PublicSchema]

GET/zones/{zone_id}/schema_validation/schemas

Get details of a schema

schema_validation.schemas.get(strschema_id, SchemaGetParams**kwargs) -> PublicSchema

GET/zones/{zone_id}/schema_validation/schemas/{schema_id}

Upload a schema

schema_validation.schemas.create(SchemaCreateParams**kwargs) -> PublicSchema

POST/zones/{zone_id}/schema_validation/schemas

Edit details of a schema to enable validation

schema_validation.schemas.edit(strschema_id, SchemaEditParams**kwargs) -> PublicSchema

PATCH/zones/{zone_id}/schema_validation/schemas/{schema_id}

Delete a schema

schema_validation.schemas.delete(strschema_id, SchemaDeleteParams**kwargs) -> SchemaDeleteResponse

DELETE/zones/{zone_id}/schema_validation/schemas/{schema_id}

ModelsExpand Collapse

class PublicSchema: …

A schema used in schema validation

created_at: datetime

formatdate-time

kind: Literal["openapi_v3"]

The kind of the schema

name: str

A human-readable name for the schema

schema_id: str

A unique identifier of this schema

maxLength36

minLength36

formatuuid

source: str

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

validation_enabled: Optional[bool]

An indicator if this schema is enabled

class SchemaDeleteResponse: …

id: str

The ID of the schema that was just deleted

formatuuid