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

client.schemaValidation.schemas.list(SchemaListParams { zone_id, omit_source, page, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<PublicSchema { created_at, kind, name, 3 more } >

GET/zones/{zone_id}/schema_validation/schemas

Get details of a schema

client.schemaValidation.schemas.get(stringschemaId, SchemaGetParams { zone_id, omit_source } params, RequestOptionsoptions?): PublicSchema { created_at, kind, name, 3 more }

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

Upload a schema

client.schemaValidation.schemas.create(SchemaCreateParams { zone_id, kind, name, 2 more } params, RequestOptionsoptions?): PublicSchema { created_at, kind, name, 3 more }

POST/zones/{zone_id}/schema_validation/schemas

Edit details of a schema to enable validation

client.schemaValidation.schemas.edit(stringschemaId, SchemaEditParams { zone_id, validation_enabled } params, RequestOptionsoptions?): PublicSchema { created_at, kind, name, 3 more }

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

Delete a schema

client.schemaValidation.schemas.delete(stringschemaId, SchemaDeleteParams { zone_id } params, RequestOptionsoptions?): SchemaDeleteResponse { id }

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?: boolean

An indicator if this schema is enabled

SchemaDeleteResponse { id }

id: string

The ID of the schema that was just deleted

formatuuid