---
title: User Schemas
---

[Skip to content](#_top)

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

[API Gateway](https://developers.cloudflare.com/api/go/resources/api_gateway)

Copy Markdown

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

---

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

# User Schemas

##### [Retrieve information about all schemas on a zone](https://developers.cloudflare.com/api/go/resources/api_gateway/subresources/user_schemas/methods/list)

Deprecated

client.APIGateway.UserSchemas.List(ctx, params) (\*V4PagePaginationArray\[[OldPublicSchema](<https://developers.cloudflare.com/api/go/resources/api_gateway#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20old_public_schema%20%3E%20(schema)>)], error)

GET/zones/{zone\_id}/api\_gateway/user\_schemas

##### [Retrieve information about a specific schema on a zone](https://developers.cloudflare.com/api/go/resources/api_gateway/subresources/user_schemas/methods/get)

Deprecated

client.APIGateway.UserSchemas.Get(ctx, schemaID, params) (\*[OldPublicSchema](<https://developers.cloudflare.com/api/go/resources/api_gateway#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20old_public_schema%20%3E%20(schema)>), error)

GET/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id}

##### [Upload a legacy schema](https://developers.cloudflare.com/api/go/resources/api_gateway/subresources/user_schemas/methods/create)

Deprecated

client.APIGateway.UserSchemas.New(ctx, params) (\*[UserSchemaNewResponse](<https://developers.cloudflare.com/api/go/resources/api_gateway#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20UserSchemaNewResponse%20%3E%20(schema)>), error)

POST/zones/{zone\_id}/api\_gateway/user\_schemas

##### [Enable validation for a schema](https://developers.cloudflare.com/api/go/resources/api_gateway/subresources/user_schemas/methods/edit)

Deprecated

client.APIGateway.UserSchemas.Edit(ctx, schemaID, params) (\*[OldPublicSchema](<https://developers.cloudflare.com/api/go/resources/api_gateway#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20old_public_schema%20%3E%20(schema)>), error)

PATCH/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id}

##### [Delete a schema](https://developers.cloudflare.com/api/go/resources/api_gateway/subresources/user_schemas/methods/delete)

Deprecated

client.APIGateway.UserSchemas.Delete(ctx, schemaID, body) (\*[UserSchemaDeleteResponse](<https://developers.cloudflare.com/api/go/resources/api_gateway#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20UserSchemaDeleteResponse%20%3E%20(schema)>), error)

DELETE/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id}

##### ModelsExpand Collapse

<details>

<summary>

type Message \[]MessageItem

</summary>

Code int64

minimum1000

<a href="#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20message%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20code">Link to this property</a>

Message string

<a href="#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20message%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20message">Link to this property</a>

DocumentationURL stringOptional

<a href="#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20message%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20documentation_url">Link to this property</a>

<details>

<summary>

Source MessageItemSourceOptional

</summary>

Pointer stringOptional

<a href="#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20message%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20source%20%3E%20(property)%20pointer">Link to this property</a>

</details>

<a href="#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20message%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20source">Link to this property</a>

</details>

[Link to this property](<#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20message%20%3E%20(schema)>)

<details>

<summary>

type OldPublicSchema struct{…}

</summary>

CreatedAt Time

formatdate-time

<a href="#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20old_public_schema%20%3E%20(schema)%20%3E%20(property)%20created_at">Link to this property</a>

Kind OldPublicSchemaKind

Kind of schema

<a href="#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20old_public_schema%20%3E%20(schema)%20%3E%20(property)%20kind">Link to this property</a>

Name string

Name of the schema

<a href="#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20old_public_schema%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

SchemaID string

UUID.

maxLength36

minLength36

<a href="#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20old_public_schema%20%3E%20(schema)%20%3E%20(property)%20schema_id">Link to this property</a>

Source stringOptional

Source of the schema

<a href="#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20old_public_schema%20%3E%20(schema)%20%3E%20(property)%20source">Link to this property</a>

ValidationEnabled boolOptional

Flag whether schema is enabled for validation.

<a href="#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20old_public_schema%20%3E%20(schema)%20%3E%20(property)%20validation_enabled">Link to this property</a>

</details>

[Link to this property](<#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20old_public_schema%20%3E%20(schema)>)

#### User SchemasOperations

##### [Retrieve all operations from a schema](https://developers.cloudflare.com/api/go/resources/api_gateway/subresources/user_schemas/subresources/operations/methods/list)

Deprecated

client.APIGateway.UserSchemas.Operations.List(ctx, schemaID, params) (\*V4PagePaginationArray\[[UserSchemaOperationListResponse](<https://developers.cloudflare.com/api/go/resources/api_gateway#(resource)%20api_gateway.user_schemas.operations%20%3E%20(model)%20UserSchemaOperationListResponse%20%3E%20(schema)>)], error)

GET/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id}/operations

#### User SchemasHosts

##### [Retrieve schema hosts in a zone](https://developers.cloudflare.com/api/go/resources/api_gateway/subresources/user_schemas/subresources/hosts/methods/list)

Deprecated

client.APIGateway.UserSchemas.Hosts.List(ctx, params) (\*V4PagePaginationArray\[[UserSchemaHostListResponse](<https://developers.cloudflare.com/api/go/resources/api_gateway#(resource)%20api_gateway.user_schemas.hosts%20%3E%20(model)%20UserSchemaHostListResponse%20%3E%20(schema)>)], error)

GET/zones/{zone\_id}/api\_gateway/user\_schemas/hosts