--- title: User Schemas --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [API Gateway](https://developers.cloudflare.com/api/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/resources/api_gateway/subresources/user_schemas/methods/list) Deprecated GET/zones/{zone\_id}/api\_gateway/user\_schemas ##### [Retrieve information about a specific schema on a zone](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas/methods/get) Deprecated GET/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id} ##### [Upload a legacy schema](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas/methods/create) Deprecated POST/zones/{zone\_id}/api\_gateway/user\_schemas ##### [Enable validation for a schema](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas/methods/edit) Deprecated PATCH/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id} ##### [Delete a schema](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas/methods/delete) Deprecated DELETE/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id} ##### ModelsExpand Collapse

Message = array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

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

OldPublicSchema object {created\_at, kind, name, 3 more }

created\_at: string formatdate-time Link to this property kind: "openapi\_v3" Kind of schema Link to this property name: string Name of the schema Link to this property schema\_id: string UUID. maxLength36 minLength36 Link to this property source: optional string Source of the schema Link to this property validation\_enabled: optional boolean Flag whether schema is enabled for validation. Link to this property

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

UserSchemaCreateResponse object {schema, upload\_details }

schema: OldPublicSchema { created\_at, kind, name, 3 more } Link to this property

upload\_details: optional object {warnings }

warnings: optional array of object {code, locations, message } Diagnostic warning events that occurred during processing. These events are non-critical errors found within the schema.

code: number Code that identifies the event that occurred. Link to this property locations: optional array of string JSONPath location(s) in the schema where these events were encountered. See https://goessner.net/articles/JsonPath/ for JSONPath specification. Link to this property message: optional string Diagnostic message that describes the event. Link to this property

Link to this property

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

UserSchemaDeleteResponse object {errors, messages, success }

errors: Message { code, message, documentation\_url, source } Link to this property messages: Message { code, message, documentation\_url, source } Link to this property success: true Whether the API call was successful. Link to this property

[Link to this property](<#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20user_schema_delete_response%20%3E%20(schema)>) #### User SchemasOperations ##### [Retrieve all operations from a schema](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas/subresources/operations/methods/list) Deprecated GET/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id}/operations ##### ModelsExpand Collapse

OperationListResponse = object {endpoint, host, last\_updated, 3 more } or object {endpoint, host, method }

One of the following:

APIShieldOperation object {endpoint, host, last\_updated, 3 more }

endpoint: string The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/. formaturi-template maxLength4096 Link to this property host: string RFC3986-compliant host. formathostname maxLength255 Link to this property last\_updated: string formatdate-time Link to this property

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

One of the following: "GET" Link to this property "POST" Link to this property "HEAD" Link to this property "OPTIONS" Link to this property "PUT" Link to this property "DELETE" Link to this property "CONNECT" Link to this property "PATCH" Link to this property "TRACE" Link to this property

Link to this property operation\_id: string UUID. maxLength36 minLength36 Link to this property

features: optional object {thresholds } or object {parameter\_schemas } or object {api\_routing } or 2 more

One of the following:

APIShieldOperationFeatureThresholds object {thresholds }

thresholds: optional object {auth\_id\_tokens, data\_points, last\_updated, 6 more }

auth\_id\_tokens: optional number The total number of auth-ids seen across this calculation. Link to this property data\_points: optional number The number of data points used for the threshold suggestion calculation. Link to this property last\_updated: optional string formatdate-time Link to this property p50: optional number The p50 quantile of requests (in period\_seconds). Link to this property p90: optional number The p90 quantile of requests (in period\_seconds). Link to this property p99: optional number The p99 quantile of requests (in period\_seconds). Link to this property period\_seconds: optional number The period over which this threshold is suggested. Link to this property requests: optional number The estimated number of requests covered by these calculations. Link to this property suggested\_threshold: optional number The suggested threshold in requests done by the same auth\_id or period\_seconds. Link to this property

Link to this property

APIShieldOperationFeatureParameterSchemas object {parameter\_schemas }

parameter\_schemas: object {last\_updated, parameter\_schemas }

last\_updated: optional string formatdate-time Link to this property

parameter\_schemas: optional object {parameters, responses } An operation schema object containing a response.

parameters: optional array of unknown An array containing the learned parameter schemas. Link to this property responses: optional unknown An empty response object. This field is required to yield a valid operation schema. Link to this property

Link to this property

APIShieldOperationFeatureAPIRouting object {api\_routing }

api\_routing: optional object {last\_updated, route } API Routing settings on endpoint.

last\_updated: optional string formatdate-time Link to this property route: optional string Target route. Link to this property

Link to this property

APIShieldOperationFeatureConfidenceIntervals object {confidence\_intervals }

confidence\_intervals: optional object {last\_updated, suggested\_threshold }

last\_updated: optional string formatdate-time Link to this property

suggested\_threshold: optional object {confidence\_intervals, mean }

confidence\_intervals: optional object {p90, p95, p99 }

p90: optional object {lower, upper } Upper and lower bound for percentile estimate

lower: optional number Lower bound for percentile estimate Link to this property upper: optional number Upper bound for percentile estimate Link to this property

Link to this property

p95: optional object {lower, upper } Upper and lower bound for percentile estimate

lower: optional number Lower bound for percentile estimate Link to this property upper: optional number Upper bound for percentile estimate Link to this property

Link to this property

p99: optional object {lower, upper } Upper and lower bound for percentile estimate

lower: optional number Lower bound for percentile estimate Link to this property upper: optional number Upper bound for percentile estimate Link to this property

Link to this property

Link to this property mean: optional number Suggested threshold. Link to this property

Link to this property

APIShieldOperationFeatureSchemaInfo object {schema\_info }

schema\_info: optional object {active\_schema, mitigation\_action }

active\_schema: optional object {id, created\_at, name } Schema active on endpoint.

id: optional string UUID. maxLength36 minLength36 Link to this property created\_at: optional string formatdate-time Link to this property name: optional string Schema file name. Link to this property

Link to this property

mitigation\_action: optional "none"or "log"or "block" Action taken on requests failing validation.

One of the following: "none" Link to this property "log" Link to this property "block" Link to this property

Link to this property

APIShieldBasicOperation object {endpoint, host, method }

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

Link to this property

[Link to this property](<#(resource)%20api_gateway.user_schemas.operations%20%3E%20(model)%20operation_list_response%20%3E%20(schema)>) #### User SchemasHosts ##### [Retrieve schema hosts in a zone](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas/subresources/hosts/methods/list) Deprecated GET/zones/{zone\_id}/api\_gateway/user\_schemas/hosts ##### ModelsExpand Collapse

HostListResponse object {created\_at, hosts, name, schema\_id }

created\_at: string formatdate-time Link to this property hosts: array of string Hosts serving the schema, e.g zone.host.com Link to this property name: string Name of the schema Link to this property schema\_id: string UUID. maxLength36 minLength36 Link to this property

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