--- title: Operations --- [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** # Operations ##### [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)>) #### OperationsLabels ##### [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)>) #### OperationsSchema 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)>)