--- title: Get a web or API operation --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [API Gateway](https://developers.cloudflare.com/api/python/resources/api_gateway) [Operations](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/operations) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get a web or API operation api\_gateway.operations.get(stroperation\_id, OperationGetParams\*\*kwargs) -> [OperationGetResponse]() GET/zones/{zone\_id}/api\_gateway/operations/{operation\_id} Returns a web or API operation, including its schema validation settings and requested feature data. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Account API Gateway``Account API Gateway Read``Domain API Gateway``Domain API Gateway Read` ##### ParametersExpand Collapse zone\_id: str Identifier. maxLength32 [Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>) operation\_id: str UUID. maxLength36 [Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20operation_id%20%3E%20(schema)>)
feature: Optional\[List\[Literal\["thresholds", "parameter\_schemas", "schema\_info", "confidence\_intervals"]]] Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning. One of the following: "thresholds" Link to this property "parameter\_schemas" Link to this property "schema\_info" Link to this property "confidence\_intervals" Link to this property
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20feature%20%3E%20(schema)>) with\_schemas: Optional\[[bool]()] When true, includes OpenAPI schemas (both uploaded and learned) for the operation in the response. Due to the conversion overhead, this parameter is only supported on single-operation retrieval. [Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20with_schemas%20%3E%20(schema)>) ##### ReturnsExpand Collapse
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)>) ### Get a web or API operation Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) operation = client.api_gateway.operations.get( operation_id="f174e90a-fafe-4643-bbbc-4a0ed4fc8415", zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(operation.operation_id) ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "endpoint": "/api/v1/users/{var1}", "host": "www.example.com", "last_updated": "2014-01-01T05:20:00.12345Z", "method": "GET", "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "features": { "api_routing": { "last_updated": "2014-01-01T05:20:00.12345Z", "route": "https://api.example.com/api/service" } }, "schemas": { "learned": { "parameters": [ { "foo": "bar" } ], "requestBody": { "foo": "bar" } }, "uploaded": { "parameters": [ { "foo": "bar" } ], "requestBody": { "foo": "bar" } } } }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "endpoint": "/api/v1/users/{var1}", "host": "www.example.com", "last_updated": "2014-01-01T05:20:00.12345Z", "method": "GET", "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "features": { "api_routing": { "last_updated": "2014-01-01T05:20:00.12345Z", "route": "https://api.example.com/api/service" } }, "schemas": { "learned": { "parameters": [ { "foo": "bar" } ], "requestBody": { "foo": "bar" } }, "uploaded": { "parameters": [ { "foo": "bar" } ], "requestBody": { "foo": "bar" } } } }, "success": true } ```