--- title: User Schemas --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [API Gateway](https://developers.cloudflare.com/api/python/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/python/resources/api_gateway/subresources/user_schemas/methods/list) Deprecated api\_gateway.user\_schemas.list(UserSchemaListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[OldPublicSchema]()] GET/zones/{zone\_id}/api\_gateway/user\_schemas ##### [Retrieve information about a specific schema on a zone](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/user_schemas/methods/get) Deprecated api\_gateway.user\_schemas.get(strschema\_id, UserSchemaGetParams\*\*kwargs) -> [OldPublicSchema]() GET/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id} ##### [Upload a legacy schema](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/user_schemas/methods/create) Deprecated api\_gateway.user\_schemas.create(UserSchemaCreateParams\*\*kwargs) -> [UserSchemaCreateResponse]() POST/zones/{zone\_id}/api\_gateway/user\_schemas ##### [Enable validation for a schema](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/user_schemas/methods/edit) Deprecated api\_gateway.user\_schemas.edit(strschema\_id, UserSchemaEditParams\*\*kwargs) -> [OldPublicSchema]() PATCH/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id} ##### [Delete a schema](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/user_schemas/methods/delete) Deprecated api\_gateway.user\_schemas.delete(strschema\_id, UserSchemaDeleteParams\*\*kwargs) -> [UserSchemaDeleteResponse]() DELETE/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id} ##### ModelsExpand Collapse
List\[MessageItem] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[MessageItemSource] pointer: Optional\[str] 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)>)
class OldPublicSchema: … created\_at: datetime formatdate-time Link to this property kind: Literal\["openapi\_v3"] Kind of schema Link to this property name: str Name of the schema Link to this property schema\_id: str UUID. maxLength36 minLength36 Link to this property source: Optional\[str] Source of the schema Link to this property validation\_enabled: Optional\[bool] 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)>)
class UserSchemaCreateResponse: … schema: OldPublicSchema Link to this property
upload\_details: Optional\[UploadDetails]
warnings: Optional\[List\[UploadDetailsWarning]] Diagnostic warning events that occurred during processing. These events are non-critical errors found within the schema. code: int Code that identifies the event that occurred. Link to this property locations: Optional\[List\[str]] 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\[str] Diagnostic message that describes the event. Link to this property
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)>)
class UserSchemaDeleteResponse: … errors: Message Link to this property messages: Message Link to this property success: Literal\[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/python/resources/api_gateway/subresources/user_schemas/subresources/operations/methods/list) Deprecated api\_gateway.user\_schemas.operations.list(strschema\_id, OperationListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[OperationListResponse]()] GET/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id}/operations ##### ModelsExpand Collapse
OperationListResponse One of the following:
class APIShieldOperation: … endpoint: str 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: str RFC3986-compliant host. formathostname maxLength255 Link to this property last\_updated: datetime formatdate-time Link to this property
method: Literal\["GET", "POST", "HEAD", 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: str UUID. maxLength36 minLength36 Link to this property
features: Optional\[APIShieldOperationFeatures] One of the following:
class APIShieldOperationFeaturesAPIShieldOperationFeatureThresholds: …
thresholds: Optional\[APIShieldOperationFeaturesAPIShieldOperationFeatureThresholdsThresholds] auth\_id\_tokens: Optional\[int] The total number of auth-ids seen across this calculation. Link to this property data\_points: Optional\[int] The number of data points used for the threshold suggestion calculation. Link to this property last\_updated: Optional\[datetime] formatdate-time Link to this property p50: Optional\[int] The p50 quantile of requests (in period\_seconds). Link to this property p90: Optional\[int] The p90 quantile of requests (in period\_seconds). Link to this property p99: Optional\[int] The p99 quantile of requests (in period\_seconds). Link to this property period\_seconds: Optional\[int] The period over which this threshold is suggested. Link to this property requests: Optional\[int] The estimated number of requests covered by these calculations. Link to this property suggested\_threshold: Optional\[int] The suggested threshold in requests done by the same auth\_id or period\_seconds. Link to this property
Link to this property
Link to this property
class APIShieldOperationFeaturesAPIShieldOperationFeatureParameterSchemas: …
parameter\_schemas: APIShieldOperationFeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemas last\_updated: Optional\[datetime] formatdate-time Link to this property
parameter\_schemas: Optional\[APIShieldOperationFeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemasParameterSchemas] An operation schema object containing a response. parameters: Optional\[List\[object]] An array containing the learned parameter schemas. Link to this property responses: Optional\[object] An empty response object. This field is required to yield a valid operation schema. Link to this property
Link to this property
Link to this property
Link to this property
class APIShieldOperationFeaturesAPIShieldOperationFeatureAPIRouting: …
api\_routing: Optional\[APIShieldOperationFeaturesAPIShieldOperationFeatureAPIRoutingAPIRouting] API Routing settings on endpoint. last\_updated: Optional\[datetime] formatdate-time Link to this property route: Optional\[str] Target route. Link to this property
Link to this property
Link to this property
class APIShieldOperationFeaturesAPIShieldOperationFeatureConfidenceIntervals: …
confidence\_intervals: Optional\[APIShieldOperationFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervals] last\_updated: Optional\[datetime] formatdate-time Link to this property
suggested\_threshold: Optional\[APIShieldOperationFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThreshold]
confidence\_intervals: Optional\[APIShieldOperationFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervals]
p90: Optional\[APIShieldOperationFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90] Upper and lower bound for percentile estimate lower: Optional\[float] Lower bound for percentile estimate Link to this property upper: Optional\[float] Upper bound for percentile estimate Link to this property
Link to this property
p95: Optional\[APIShieldOperationFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95] Upper and lower bound for percentile estimate lower: Optional\[float] Lower bound for percentile estimate Link to this property upper: Optional\[float] Upper bound for percentile estimate Link to this property
Link to this property
p99: Optional\[APIShieldOperationFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99] Upper and lower bound for percentile estimate lower: Optional\[float] Lower bound for percentile estimate Link to this property upper: Optional\[float] Upper bound for percentile estimate Link to this property
Link to this property
Link to this property mean: Optional\[float] Suggested threshold. Link to this property
Link to this property
Link to this property
Link to this property
class APIShieldOperationFeaturesAPIShieldOperationFeatureSchemaInfo: …
schema\_info: Optional\[APIShieldOperationFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfo]
active\_schema: Optional\[APIShieldOperationFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoActiveSchema] Schema active on endpoint. id: Optional\[str] UUID. maxLength36 minLength36 Link to this property created\_at: Optional\[datetime] formatdate-time Link to this property name: Optional\[str] Schema file name. Link to this property
Link to this property
mitigation\_action: Optional\[Literal\["none", "log", "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
Link to this property
Link to this property
Link to this property
Link to this property
class APIShieldBasicOperation: … endpoint: str 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: str RFC3986-compliant host. formathostname maxLength255 Link to this property
method: Literal\["GET", "POST", "HEAD", 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
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/python/resources/api_gateway/subresources/user_schemas/subresources/hosts/methods/list) Deprecated api\_gateway.user\_schemas.hosts.list(HostListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[HostListResponse]()] GET/zones/{zone\_id}/api\_gateway/user\_schemas/hosts ##### ModelsExpand Collapse
class HostListResponse: … created\_at: datetime formatdate-time Link to this property hosts: List\[str] Hosts serving the schema, e.g zone.host.com Link to this property name: str Name of the schema Link to this property schema\_id: str 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)>)