--- title: API Gateway --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # API Gateway #### API GatewayConfigurations ##### [Get session identifier settings](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/configurations/methods/get) api\_gateway.configurations.get(ConfigurationGetParams\*\*kwargs) -> [Configuration]() GET/zones/{zone\_id}/api\_gateway/configuration ##### [Update session identifier settings](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/configurations/methods/update) api\_gateway.configurations.update(ConfigurationUpdateParams\*\*kwargs) -> [Configuration]() PUT/zones/{zone\_id}/api\_gateway/configuration ##### ModelsExpand Collapse
class Configuration: …
auth\_id\_characteristics: List\[AuthIDCharacteristic] One of the following:
class AuthIDCharacteristicAPIShieldAuthIDCharacteristic: … Auth ID Characteristic name: str The name of the characteristic field, i.e., the header or cookie name. maxLength128 Link to this property
type: Literal\["header", "cookie"] The type of characteristic. One of the following: "header" Link to this property "cookie" Link to this property
Link to this property
Link to this property
class AuthIDCharacteristicAPIShieldAuthIDCharacteristicJWTClaim: … Auth ID Characteristic extracted from JWT Token Claims name: str Claim location expressed as $(token_config_id):$(json_path), where token_config_id is the ID of the token configuration used in validating the JWT, and json_path is a RFC 9535 JSONPath (https://goessner.net/articles/JsonPath/, https://www.rfc-editor.org/rfc/rfc9535.html). The JSONPath expression may be in dot or bracket notation, may only specify literal keys or array indexes, and must return a singleton value, which will be interpreted as a string. maxLength128 Link to this property type: Literal\["jwt"] The type of characteristic. Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.configurations%20%3E%20(model)%20configuration%20%3E%20(schema)>) #### API GatewayDiscovery ##### [Export discovered API operations as OpenAPI schemas](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/discovery/methods/get) api\_gateway.discovery.get(DiscoveryGetParams\*\*kwargs) -> [DiscoveryGetResponse]() GET/zones/{zone\_id}/api\_gateway/discovery ##### ModelsExpand Collapse
class DiscoveryOperation: … id: str UUID. maxLength36 minLength36 Link to this property 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
origin: List\[Literal\["ML", "SessionIdentifier", "LabelDiscovery"]] API discovery engine(s) that discovered this operation One of the following: "ML" Link to this property "SessionIdentifier" Link to this property "LabelDiscovery" Link to this property
Link to this property
state: Literal\["review", "saved", "ignored"] State of operation in API Discovery - review - Operation is not saved into API Shield Endpoint Management - saved - Operation is saved into API Shield Endpoint Management - ignored - Operation is marked as ignored One of the following: "review" Link to this property "saved" Link to this property "ignored" Link to this property
Link to this property
features: Optional\[Features]
traffic\_stats: Optional\[FeaturesTrafficStats] last\_updated: datetime formatdate-time Link to this property period\_seconds: int The period in seconds these statistics were computed over Link to this property requests: float The average number of requests seen during this period formatfloat Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.discovery%20%3E%20(model)%20discovery_operation%20%3E%20(schema)>)
class DiscoveryGetResponse: … schemas: List\[object] Link to this property timestamp: datetime formatdate-time Link to this property
[Link to this property](<#(resource)%20api_gateway.discovery%20%3E%20(model)%20discovery_get_response%20%3E%20(schema)>) #### API GatewayDiscoveryOperations ##### [List discovered web and API operations](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/discovery/subresources/operations/methods/list) api\_gateway.discovery.operations.list(OperationListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[DiscoveryOperation]()] GET/zones/{zone\_id}/api\_gateway/discovery/operations ##### [Edit discovered web and API operations](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/discovery/subresources/operations/methods/bulk_edit) api\_gateway.discovery.operations.bulk\_edit(OperationBulkEditParams\*\*kwargs) -> [OperationBulkEditResponse]() PATCH/zones/{zone\_id}/api\_gateway/discovery/operations ##### ModelsExpand Collapse
Dict\[str, OperationBulkEditResponseItem]
state: Optional\[Literal\["review", "ignored"]] Mark state of operation in API Discovery - review - Mark operation as for review - ignored - Mark operation as ignored One of the following: "review" Link to this property "ignored" Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.discovery.operations%20%3E%20(model)%20operation_bulk_edit_response%20%3E%20(schema)>) #### API GatewayLabels ##### [List operation labels](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/labels/methods/list) api\_gateway.labels.list(LabelListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[LabelListResponse]()] GET/zones/{zone\_id}/api\_gateway/labels ##### ModelsExpand Collapse
class LabelListResponse: … created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property mapped\_resources: Optional\[object] Provides counts of what resources are linked to this label Link to this property
[Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(model)%20label_list_response%20%3E%20(schema)>) #### API GatewayLabelsUser ##### [Create user-defined operation labels](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/labels/subresources/user/methods/bulk_create) api\_gateway.labels.user.bulk\_create(UserBulkCreateParams\*\*kwargs) -> SyncSinglePage\[[UserBulkCreateResponse]()] POST/zones/{zone\_id}/api\_gateway/labels/user ##### [Delete user-defined operation labels](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/labels/subresources/user/methods/bulk_delete) api\_gateway.labels.user.bulk\_delete(UserBulkDeleteParams\*\*kwargs) -> SyncSinglePage\[[UserBulkDeleteResponse]()] DELETE/zones/{zone\_id}/api\_gateway/labels/user ##### [Get a user-defined operation label](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/labels/subresources/user/methods/get) api\_gateway.labels.user.get(strname, UserGetParams\*\*kwargs) -> [UserGetResponse]() GET/zones/{zone\_id}/api\_gateway/labels/user/{name} ##### [Update a user-defined operation label](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/labels/subresources/user/methods/update) api\_gateway.labels.user.update(strname, UserUpdateParams\*\*kwargs) -> [UserUpdateResponse]() PUT/zones/{zone\_id}/api\_gateway/labels/user/{name} ##### [Edit a user-defined operation label](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/labels/subresources/user/methods/edit) api\_gateway.labels.user.edit(strname, UserEditParams\*\*kwargs) -> [UserEditResponse]() PATCH/zones/{zone\_id}/api\_gateway/labels/user/{name} ##### [Delete a user-defined operation label](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/labels/subresources/user/methods/delete) api\_gateway.labels.user.delete(strname, UserDeleteParams\*\*kwargs) -> [UserDeleteResponse]() DELETE/zones/{zone\_id}/api\_gateway/labels/user/{name} ##### ModelsExpand Collapse
class UserBulkCreateResponse: … created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.labels.user%20%3E%20(model)%20user_bulk_create_response%20%3E%20(schema)>)
class UserBulkDeleteResponse: … created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.labels.user%20%3E%20(model)%20user_bulk_delete_response%20%3E%20(schema)>)
class UserGetResponse: … created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property mapped\_resources: Optional\[object] Provides counts of what resources are linked to this label Link to this property
[Link to this property](<#(resource)%20api_gateway.labels.user%20%3E%20(model)%20user_get_response%20%3E%20(schema)>)
class UserUpdateResponse: … created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.labels.user%20%3E%20(model)%20user_update_response%20%3E%20(schema)>)
class UserEditResponse: … created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.labels.user%20%3E%20(model)%20user_edit_response%20%3E%20(schema)>)
class UserDeleteResponse: … created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.labels.user%20%3E%20(model)%20user_delete_response%20%3E%20(schema)>) #### API GatewayLabelsUserResources #### API GatewayLabelsUserResourcesOperation ##### [Replace operations attached to a user-defined label](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/labels/subresources/user/subresources/resources/subresources/operation/methods/update) api\_gateway.labels.user.resources.operation.update(strname, OperationUpdateParams\*\*kwargs) -> [OperationUpdateResponse]() PUT/zones/{zone\_id}/api\_gateway/labels/user/{name}/resources/operation ##### ModelsExpand Collapse
class OperationUpdateResponse: … created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property mapped\_resources: Optional\[object] Provides counts of what resources are linked to this label Link to this property
[Link to this property](<#(resource)%20api_gateway.labels.user.resources.operation%20%3E%20(model)%20operation_update_response%20%3E%20(schema)>) #### API GatewayLabelsManaged ##### [Get a managed operation label](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/labels/subresources/managed/methods/get) api\_gateway.labels.managed.get(strname, ManagedGetParams\*\*kwargs) -> [ManagedGetResponse]() GET/zones/{zone\_id}/api\_gateway/labels/managed/{name} ##### ModelsExpand Collapse
class ManagedGetResponse: … created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property mapped\_resources: Optional\[object] Provides counts of what resources are linked to this label Link to this property
[Link to this property](<#(resource)%20api_gateway.labels.managed%20%3E%20(model)%20managed_get_response%20%3E%20(schema)>) #### API GatewayLabelsManagedResources #### API GatewayLabelsManagedResourcesOperation ##### [Replace operations attached to a managed label](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/labels/subresources/managed/subresources/resources/subresources/operation/methods/update) api\_gateway.labels.managed.resources.operation.update(strname, OperationUpdateParams\*\*kwargs) -> [OperationUpdateResponse]() PUT/zones/{zone\_id}/api\_gateway/labels/managed/{name}/resources/operation ##### ModelsExpand Collapse
class OperationUpdateResponse: … created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property mapped\_resources: Optional\[object] Provides counts of what resources are linked to this label Link to this property
[Link to this property](<#(resource)%20api_gateway.labels.managed.resources.operation%20%3E%20(model)%20operation_update_response%20%3E%20(schema)>) #### API GatewayOperations ##### [List web and API operations](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/methods/list) api\_gateway.operations.list(OperationListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[OperationListResponse]()] GET/zones/{zone\_id}/api\_gateway/operations ##### [Get a web or API operation](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/methods/get) api\_gateway.operations.get(stroperation\_id, OperationGetParams\*\*kwargs) -> [OperationGetResponse]() GET/zones/{zone\_id}/api\_gateway/operations/{operation\_id} ##### [Create a web or API operation](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/methods/create) api\_gateway.operations.create(OperationCreateParams\*\*kwargs) -> [OperationCreateResponse]() POST/zones/{zone\_id}/api\_gateway/operations/item ##### [Delete a web or API operation](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/methods/delete) api\_gateway.operations.delete(stroperation\_id, OperationDeleteParams\*\*kwargs) -> [OperationDeleteResponse]() DELETE/zones/{zone\_id}/api\_gateway/operations/{operation\_id} ##### [Create web or API operations](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/methods/bulk_create) api\_gateway.operations.bulk\_create(OperationBulkCreateParams\*\*kwargs) -> SyncSinglePage\[[OperationBulkCreateResponse]()] POST/zones/{zone\_id}/api\_gateway/operations ##### [Delete web or API operations](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/methods/bulk_delete) api\_gateway.operations.bulk\_delete(OperationBulkDeleteParams\*\*kwargs) -> [OperationBulkDeleteResponse]() DELETE/zones/{zone\_id}/api\_gateway/operations ##### ModelsExpand Collapse
class APIShield: … 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
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(model)%20api-shield%20%3E%20(schema)>)
class OperationListResponse: … 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\[Features] One of the following:
class FeaturesAPIShieldOperationFeatureThresholds: …
thresholds: Optional\[FeaturesAPIShieldOperationFeatureThresholdsThresholds] 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 FeaturesAPIShieldOperationFeatureParameterSchemas: …
parameter\_schemas: FeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemas last\_updated: Optional\[datetime] formatdate-time Link to this property
parameter\_schemas: Optional\[FeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemasParameterSchemas] 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 FeaturesAPIShieldOperationFeatureAPIRouting: …
api\_routing: Optional\[FeaturesAPIShieldOperationFeatureAPIRoutingAPIRouting] 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 FeaturesAPIShieldOperationFeatureConfidenceIntervals: …
confidence\_intervals: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervals] last\_updated: Optional\[datetime] formatdate-time Link to this property
suggested\_threshold: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThreshold]
confidence\_intervals: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervals]
p90: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90] 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\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95] 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\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99] 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 FeaturesAPIShieldOperationFeatureSchemaInfo: …
schema\_info: Optional\[FeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfo]
active\_schema: Optional\[FeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoActiveSchema] 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](<#(resource)%20api_gateway.operations%20%3E%20(model)%20operation_list_response%20%3E%20(schema)>)
class OperationGetResponse: … 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\[Features] One of the following:
class FeaturesAPIShieldOperationFeatureThresholds: …
thresholds: Optional\[FeaturesAPIShieldOperationFeatureThresholdsThresholds] 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 FeaturesAPIShieldOperationFeatureParameterSchemas: …
parameter\_schemas: FeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemas last\_updated: Optional\[datetime] formatdate-time Link to this property
parameter\_schemas: Optional\[FeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemasParameterSchemas] 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 FeaturesAPIShieldOperationFeatureAPIRouting: …
api\_routing: Optional\[FeaturesAPIShieldOperationFeatureAPIRoutingAPIRouting] 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 FeaturesAPIShieldOperationFeatureConfidenceIntervals: …
confidence\_intervals: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervals] last\_updated: Optional\[datetime] formatdate-time Link to this property
suggested\_threshold: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThreshold]
confidence\_intervals: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervals]
p90: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90] 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\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95] 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\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99] 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 FeaturesAPIShieldOperationFeatureSchemaInfo: …
schema\_info: Optional\[FeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfo]
active\_schema: Optional\[FeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoActiveSchema] 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
schemas: Optional\[Schemas] OpenAPI JSON schemas for an operation, including both user-uploaded and Cloudflare-learned schemas.
learned: Optional\[SchemasLearned] An OpenAPI operation object fragment containing schema information for an operation. May include parameter definitions, request body specifications, and a component schema extension. parameters: Optional\[List\[Dict\[str, object]]] OpenAPI parameter objects describing path, query, header, or cookie parameters. Link to this property request\_body: Optional\[Dict\[str, object]] OpenAPI request body object describing the expected request payload. Link to this property
Link to this property
uploaded: Optional\[SchemasUploaded] An OpenAPI operation object fragment containing schema information for an operation. May include parameter definitions, request body specifications, and a component schema extension. parameters: Optional\[List\[Dict\[str, object]]] OpenAPI parameter objects describing path, query, header, or cookie parameters. Link to this property request\_body: Optional\[Dict\[str, object]] OpenAPI request body object describing the expected request payload. Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(model)%20operation_get_response%20%3E%20(schema)>)
class OperationCreateResponse: … 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\[Features] One of the following:
class FeaturesAPIShieldOperationFeatureThresholds: …
thresholds: Optional\[FeaturesAPIShieldOperationFeatureThresholdsThresholds] 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 FeaturesAPIShieldOperationFeatureParameterSchemas: …
parameter\_schemas: FeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemas last\_updated: Optional\[datetime] formatdate-time Link to this property
parameter\_schemas: Optional\[FeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemasParameterSchemas] 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 FeaturesAPIShieldOperationFeatureAPIRouting: …
api\_routing: Optional\[FeaturesAPIShieldOperationFeatureAPIRoutingAPIRouting] 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 FeaturesAPIShieldOperationFeatureConfidenceIntervals: …
confidence\_intervals: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervals] last\_updated: Optional\[datetime] formatdate-time Link to this property
suggested\_threshold: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThreshold]
confidence\_intervals: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervals]
p90: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90] 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\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95] 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\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99] 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 FeaturesAPIShieldOperationFeatureSchemaInfo: …
schema\_info: Optional\[FeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfo]
active\_schema: Optional\[FeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoActiveSchema] 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
schemas: Optional\[Schemas] OpenAPI JSON schemas for an operation, including both user-uploaded and Cloudflare-learned schemas.
learned: Optional\[SchemasLearned] An OpenAPI operation object fragment containing schema information for an operation. May include parameter definitions, request body specifications, and a component schema extension. parameters: Optional\[List\[Dict\[str, object]]] OpenAPI parameter objects describing path, query, header, or cookie parameters. Link to this property request\_body: Optional\[Dict\[str, object]] OpenAPI request body object describing the expected request payload. Link to this property
Link to this property
uploaded: Optional\[SchemasUploaded] An OpenAPI operation object fragment containing schema information for an operation. May include parameter definitions, request body specifications, and a component schema extension. parameters: Optional\[List\[Dict\[str, object]]] OpenAPI parameter objects describing path, query, header, or cookie parameters. Link to this property request\_body: Optional\[Dict\[str, object]] OpenAPI request body object describing the expected request payload. Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(model)%20operation_create_response%20%3E%20(schema)>)
class OperationDeleteResponse: … 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.operations%20%3E%20(model)%20operation_delete_response%20%3E%20(schema)>)
class OperationBulkCreateResponse: … 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\[Features] One of the following:
class FeaturesAPIShieldOperationFeatureThresholds: …
thresholds: Optional\[FeaturesAPIShieldOperationFeatureThresholdsThresholds] 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 FeaturesAPIShieldOperationFeatureParameterSchemas: …
parameter\_schemas: FeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemas last\_updated: Optional\[datetime] formatdate-time Link to this property
parameter\_schemas: Optional\[FeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemasParameterSchemas] 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 FeaturesAPIShieldOperationFeatureAPIRouting: …
api\_routing: Optional\[FeaturesAPIShieldOperationFeatureAPIRoutingAPIRouting] 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 FeaturesAPIShieldOperationFeatureConfidenceIntervals: …
confidence\_intervals: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervals] last\_updated: Optional\[datetime] formatdate-time Link to this property
suggested\_threshold: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThreshold]
confidence\_intervals: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervals]
p90: Optional\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90] 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\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95] 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\[FeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99] 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 FeaturesAPIShieldOperationFeatureSchemaInfo: …
schema\_info: Optional\[FeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfo]
active\_schema: Optional\[FeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoActiveSchema] 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](<#(resource)%20api_gateway.operations%20%3E%20(model)%20operation_bulk_create_response%20%3E%20(schema)>)
class OperationBulkDeleteResponse: … 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.operations%20%3E%20(model)%20operation_bulk_delete_response%20%3E%20(schema)>) #### API GatewayOperationsLabels ##### [Replace labels on a web or API operation](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/subresources/labels/methods/update) api\_gateway.operations.labels.update(stroperation\_id, LabelUpdateParams\*\*kwargs) -> [LabelUpdateResponse]() PUT/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/labels ##### [Attach labels to a web or API operation](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/subresources/labels/methods/create) api\_gateway.operations.labels.create(stroperation\_id, LabelCreateParams\*\*kwargs) -> [LabelCreateResponse]() POST/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/labels ##### [Remove labels from a web or API operation](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/subresources/labels/methods/delete) api\_gateway.operations.labels.delete(stroperation\_id, LabelDeleteParams\*\*kwargs) -> [LabelDeleteResponse]() DELETE/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/labels ##### [Replace labels on web or API operations](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/subresources/labels/methods/bulk_update) api\_gateway.operations.labels.bulk\_update(LabelBulkUpdateParams\*\*kwargs) -> SyncSinglePage\[[LabelBulkUpdateResponse]()] PUT/zones/{zone\_id}/api\_gateway/operations/labels ##### [Attach labels to web or API operations](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/subresources/labels/methods/bulk_create) api\_gateway.operations.labels.bulk\_create(LabelBulkCreateParams\*\*kwargs) -> SyncSinglePage\[[LabelBulkCreateResponse]()] POST/zones/{zone\_id}/api\_gateway/operations/labels ##### [Remove labels from web or API operations](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/subresources/labels/methods/bulk_delete) api\_gateway.operations.labels.bulk\_delete(LabelBulkDeleteParams\*\*kwargs) -> SyncSinglePage\[[LabelBulkDeleteResponse]()] DELETE/zones/{zone\_id}/api\_gateway/operations/labels ##### ModelsExpand Collapse
class LabelUpdateResponse: … 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
labels: Optional\[List\[Label]] created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations.labels%20%3E%20(model)%20label_update_response%20%3E%20(schema)>)
class LabelCreateResponse: … 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
labels: Optional\[List\[Label]] created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations.labels%20%3E%20(model)%20label_create_response%20%3E%20(schema)>)
class LabelDeleteResponse: … 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
labels: Optional\[List\[Label]] created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations.labels%20%3E%20(model)%20label_delete_response%20%3E%20(schema)>)
class LabelBulkUpdateResponse: … 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
labels: Optional\[List\[Label]] created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations.labels%20%3E%20(model)%20label_bulk_update_response%20%3E%20(schema)>)
class LabelBulkCreateResponse: … 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
labels: Optional\[List\[Label]] created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations.labels%20%3E%20(model)%20label_bulk_create_response%20%3E%20(schema)>)
class LabelBulkDeleteResponse: … 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
labels: Optional\[List\[Label]] created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations.labels%20%3E%20(model)%20label_bulk_delete_response%20%3E%20(schema)>) #### API GatewayOperationsSchema Validation ##### [Retrieve operation-level schema validation settings](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/subresources/schema_validation/methods/get) Deprecated api\_gateway.operations.schema\_validation.get(stroperation\_id, SchemaValidationGetParams\*\*kwargs) -> [SchemaValidationGetResponse]() GET/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/schema\_validation ##### [Update operation-level schema validation settings](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/subresources/schema_validation/methods/update) Deprecated api\_gateway.operations.schema\_validation.update(stroperation\_id, SchemaValidationUpdateParams\*\*kwargs) -> [SchemaValidationUpdateResponse]() PUT/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/schema\_validation ##### [Update multiple operation-level schema validation settings](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations/subresources/schema_validation/methods/edit) Deprecated api\_gateway.operations.schema\_validation.edit(SchemaValidationEditParams\*\*kwargs) -> [SettingsMultipleRequest]() PATCH/zones/{zone\_id}/api\_gateway/operations/schema\_validation ##### ModelsExpand Collapse
Dict\[str, SettingsMultipleRequestItem]
mitigation\_action: Optional\[Literal\["log", "block", "none"]] When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied One of the following: "log" Link to this property "block" Link to this property "none" Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations.schema_validation%20%3E%20(model)%20settings_multiple_request%20%3E%20(schema)>)
class SchemaValidationGetResponse: …
mitigation\_action: Optional\[Literal\["log", "block", "none"]] When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied One of the following: "log" Link to this property "block" Link to this property "none" Link to this property
Link to this property operation\_id: Optional\[str] UUID. maxLength36 minLength36 Link to this property
[Link to this property](<#(resource)%20api_gateway.operations.schema_validation%20%3E%20(model)%20schema_validation_get_response%20%3E%20(schema)>)
class SchemaValidationUpdateResponse: …
mitigation\_action: Optional\[Literal\["log", "block", "none"]] When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied One of the following: "log" Link to this property "block" Link to this property "none" Link to this property
Link to this property operation\_id: Optional\[str] UUID. maxLength36 minLength36 Link to this property
[Link to this property](<#(resource)%20api_gateway.operations.schema_validation%20%3E%20(model)%20schema_validation_update_response%20%3E%20(schema)>) #### API GatewaySchemas ##### [Export web and API operations as OpenAPI schemas](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/schemas/methods/list) api\_gateway.schemas.list(SchemaListParams\*\*kwargs) -> [SchemaListResponse]() GET/zones/{zone\_id}/api\_gateway/schemas ##### ModelsExpand Collapse
class SchemaListResponse: … schemas: Optional\[List\[object]] Link to this property timestamp: Optional\[str] Link to this property
[Link to this property](<#(resource)%20api_gateway.schemas%20%3E%20(model)%20schema_list_response%20%3E%20(schema)>) #### API GatewaySettings ##### ModelsExpand Collapse
class Settings: …
validation\_default\_mitigation\_action: Optional\[Literal\["none", "log", "block"]] The default mitigation action used when there is no mitigation action defined on the operation Mitigation actions are as follows: - log - log request when request does not conform to schema - block - deny access to the site when request does not conform to schema A special value of of none will skip running schema validation entirely for the request when there is no mitigation action defined on the operation One of the following: "none" Link to this property "log" Link to this property "block" Link to this property
Link to this property validation\_override\_mitigation\_action: Optional\[Literal\["none"]] When set, this overrides both zone level and operation level mitigation actions. - none will skip running schema validation entirely for the request - null indicates that no override is in place Link to this property
[Link to this property](<#(resource)%20api_gateway.settings%20%3E%20(model)%20settings%20%3E%20(schema)>) #### API GatewaySettingsSchema Validation ##### [Retrieve zone level schema validation settings](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/settings/subresources/schema_validation/methods/get) Deprecated api\_gateway.settings.schema\_validation.get(SchemaValidationGetParams\*\*kwargs) -> [Settings]() GET/zones/{zone\_id}/api\_gateway/settings/schema\_validation ##### [Update zone level schema validation settings](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/settings/subresources/schema_validation/methods/update) Deprecated api\_gateway.settings.schema\_validation.update(SchemaValidationUpdateParams\*\*kwargs) -> [Settings]() PUT/zones/{zone\_id}/api\_gateway/settings/schema\_validation ##### [Update zone level schema validation settings](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/settings/subresources/schema_validation/methods/edit) Deprecated api\_gateway.settings.schema\_validation.edit(SchemaValidationEditParams\*\*kwargs) -> [Settings]() PATCH/zones/{zone\_id}/api\_gateway/settings/schema\_validation #### API GatewayUser 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)>) #### API GatewayUser 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)>) #### API GatewayUser 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)>) #### API GatewayExpression Template #### API GatewayExpression TemplateFallthrough ##### [Generate a fallthrough WAF expression template](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/expression_template/subresources/fallthrough/methods/create) Deprecated api\_gateway.expression\_template.fallthrough.create(FallthroughCreateParams\*\*kwargs) -> [FallthroughCreateResponse]() POST/zones/{zone\_id}/api\_gateway/expression-template/fallthrough ##### ModelsExpand Collapse
class FallthroughCreateResponse: … expression: str WAF Expression for fallthrough Link to this property title: str Title for the expression Link to this property
[Link to this property](<#(resource)%20api_gateway.expression_template.fallthrough%20%3E%20(model)%20fallthrough_create_response%20%3E%20(schema)>)