---
title: Schemas
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/typescript)

[Schema Validation](https://developers.cloudflare.com/api/typescript/resources/schema_validation)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Schemas

##### [List all uploaded schemas](https://developers.cloudflare.com/api/typescript/resources/schema_validation/subresources/schemas/methods/list)

client.schemaValidation.schemas.list(SchemaListParams {zone\_id, omit\_source, page, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray< [PublicSchema](<https://developers.cloudflare.com/api/typescript/resources/schema_validation#(resource)%20schema_validation.schemas%20%3E%20(model)%20public_schema%20%3E%20(schema)>) {created\_at, kind, name, 3 more } >

GET/zones/{zone\_id}/schema\_validation/schemas

##### [Get details of a schema](https://developers.cloudflare.com/api/typescript/resources/schema_validation/subresources/schemas/methods/get)

client.schemaValidation.schemas.get(stringschemaID, SchemaGetParams {zone\_id, omit\_source } params, RequestOptionsoptions?): [PublicSchema](<https://developers.cloudflare.com/api/typescript/resources/schema_validation#(resource)%20schema_validation.schemas%20%3E%20(model)%20public_schema%20%3E%20(schema)>) {created\_at, kind, name, 3 more }

GET/zones/{zone\_id}/schema\_validation/schemas/{schema\_id}

##### [Upload a schema](https://developers.cloudflare.com/api/typescript/resources/schema_validation/subresources/schemas/methods/create)

client.schemaValidation.schemas.create(SchemaCreateParams {zone\_id, kind, name, 2 more } params, RequestOptionsoptions?): [PublicSchema](<https://developers.cloudflare.com/api/typescript/resources/schema_validation#(resource)%20schema_validation.schemas%20%3E%20(model)%20public_schema%20%3E%20(schema)>) {created\_at, kind, name, 3 more }

POST/zones/{zone\_id}/schema\_validation/schemas

##### [Set schema validation state](https://developers.cloudflare.com/api/typescript/resources/schema_validation/subresources/schemas/methods/edit)

client.schemaValidation.schemas.edit(stringschemaID, SchemaEditParams {zone\_id, validation\_enabled } params, RequestOptionsoptions?): [PublicSchema](<https://developers.cloudflare.com/api/typescript/resources/schema_validation#(resource)%20schema_validation.schemas%20%3E%20(model)%20public_schema%20%3E%20(schema)>) {created\_at, kind, name, 3 more }

PATCH/zones/{zone\_id}/schema\_validation/schemas/{schema\_id}

##### [Delete a schema](https://developers.cloudflare.com/api/typescript/resources/schema_validation/subresources/schemas/methods/delete)

client.schemaValidation.schemas.delete(stringschemaID, SchemaDeleteParams {zone\_id } params, RequestOptionsoptions?): [SchemaDeleteResponse](<https://developers.cloudflare.com/api/typescript/resources/schema_validation#(resource)%20schema_validation.schemas%20%3E%20(model)%20schema_delete_response%20%3E%20(schema)>)| null

DELETE/zones/{zone\_id}/schema\_validation/schemas/{schema\_id}

##### ModelsExpand Collapse

<details>

<summary>

PublicSchema {created\_at, kind, name, 3 more }

A schema used in schema validation

</summary>

created\_at: string

formatdate-time

<a href="#(resource)%20schema_validation.schemas%20%3E%20(model)%20public_schema%20%3E%20(schema)%20%3E%20(property)%20created_at">Link to this property</a>

kind: "openapi\_v3"

The kind of the schema

<a href="#(resource)%20schema_validation.schemas%20%3E%20(model)%20public_schema%20%3E%20(schema)%20%3E%20(property)%20kind">Link to this property</a>

name: string

A human-readable name for the schema

<a href="#(resource)%20schema_validation.schemas%20%3E%20(model)%20public_schema%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

schema\_id: string

A unique identifier of this schema

maxLength36

minLength36

formatuuid

<a href="#(resource)%20schema_validation.schemas%20%3E%20(model)%20public_schema%20%3E%20(schema)%20%3E%20(property)%20schema_id">Link to this property</a>

source: string

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

<a href="#(resource)%20schema_validation.schemas%20%3E%20(model)%20public_schema%20%3E%20(schema)%20%3E%20(property)%20source">Link to this property</a>

validation\_enabled?: boolean

An indicator if this schema is enabled

<a href="#(resource)%20schema_validation.schemas%20%3E%20(model)%20public_schema%20%3E%20(schema)%20%3E%20(property)%20validation_enabled">Link to this property</a>

</details>

[Link to this property](<#(resource)%20schema_validation.schemas%20%3E%20(model)%20public_schema%20%3E%20(schema)>)

SchemaDeleteResponse = unknown

Schema deletion returns no result body.

[Link to this property](<#(resource)%20schema_validation.schemas%20%3E%20(model)%20schema_delete_response%20%3E%20(schema)>)