---
title: List web and API operations
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[API Gateway](https://developers.cloudflare.com/api/resources/api_gateway)
[Operations](https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# List web and API operations
GET/zones/{zone\_id}/api\_gateway/operations
Lists web and API operations tracked for the zone, including each operation’s method, path, and feature configuration.
##### 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`
##### P ath ParametersExpand Collapse
zone\_id: string
Identifier.
maxLength32
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
##### Q uery ParametersExpand Collapse
direction: optional "asc"or "desc"
Direction to order results.
One of the following:
"asc"
Link to this property
"desc"
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20direction%20%3E%20(schema)>)
endpoint: optional string
Filter results to only include endpoints containing this pattern.
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20endpoint%20%3E%20(schema)>)
feature: optional array of "thresholds"or "parameter\_schemas"or "schema\_info"or "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)%20list%20%3E%20(params)%20default%20%3E%20(param)%20feature%20%3E%20(schema)>)
host: optional array of string
Filter results to only include the specified hosts.
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20host%20%3E%20(schema)>)
method: optional array of string
Filter results to only include the specified HTTP methods.
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20method%20%3E%20(schema)>)
order: optional "method"or "host"or "endpoint"or "thresholds.$key"
Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold.
One of the following:
"method"
Link to this property
"host"
Link to this property
"endpoint"
Link to this property
"thresholds.$key"
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20order%20%3E%20(schema)>)
page: optional number
Page number of paginated results.
minimum1
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>)
per\_page: optional number
Maximum number of results per page.
maximum50
minimum5
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: Message { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: Message { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: array of object {endpoint, host, last\_updated, 3 more }
endpoint: string
The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.
formaturi-template
maxLength4096
Link to this property
host: string
RFC3986-compliant host.
formathostname
maxLength255
Link to this property
last\_updated: string
formatdate-time
Link to this property
method: "GET"or "POST"or "HEAD"or 6 more
The HTTP method used to access the endpoint.
One of the following:
"GET"
Link to this property
"POST"
Link to this property
"HEAD"
Link to this property
"OPTIONS"
Link to this property
"PUT"
Link to this property
"DELETE"
Link to this property
"CONNECT"
Link to this property
"PATCH"
Link to this property
"TRACE"
Link to this property
Link to this property
operation\_id: string
UUID.
maxLength36
minLength36
Link to this property
features: optional object {thresholds } or object {parameter\_schemas } or object {api\_routing } or 2 more
One of the following:
APIShieldOperationFeatureThresholds object {thresholds }
thresholds: optional object {auth\_id\_tokens, data\_points, last\_updated, 6 more }
auth\_id\_tokens: optional number
The total number of auth-ids seen across this calculation.
Link to this property
data\_points: optional number
The number of data points used for the threshold suggestion calculation.
Link to this property
last\_updated: optional string
formatdate-time
Link to this property
p50: optional number
The p50 quantile of requests (in period\_seconds).
Link to this property
p90: optional number
The p90 quantile of requests (in period\_seconds).
Link to this property
p99: optional number
The p99 quantile of requests (in period\_seconds).
Link to this property
period\_seconds: optional number
The period over which this threshold is suggested.
Link to this property
requests: optional number
The estimated number of requests covered by these calculations.
Link to this property
suggested\_threshold: optional number
The suggested threshold in requests done by the same auth\_id or period\_seconds.
Link to this property
Link to this property
Link to this property
APIShieldOperationFeatureParameterSchemas object {parameter\_schemas }
parameter\_schemas: object {last\_updated, parameter\_schemas }
last\_updated: optional string
formatdate-time
Link to this property
parameter\_schemas: optional object {parameters, responses }
An operation schema object containing a response.
parameters: optional array of unknown
An array containing the learned parameter schemas.
Link to this property
responses: optional unknown
An empty response object. This field is required to yield a valid operation schema.
Link to this property
Link to this property
Link to this property
Link to this property
APIShieldOperationFeatureAPIRouting object {api\_routing }
api\_routing: optional object {last\_updated, route }
API Routing settings on endpoint.
last\_updated: optional string
formatdate-time
Link to this property
route: optional string
Target route.
Link to this property
Link to this property
Link to this property
APIShieldOperationFeatureConfidenceIntervals object {confidence\_intervals }
confidence\_intervals: optional object {last\_updated, suggested\_threshold }
last\_updated: optional string
formatdate-time
Link to this property
suggested\_threshold: optional object {confidence\_intervals, mean }
confidence\_intervals: optional object {p90, p95, p99 }
p90: optional object {lower, upper }
Upper and lower bound for percentile estimate
lower: optional number
Lower bound for percentile estimate
Link to this property
upper: optional number
Upper bound for percentile estimate
Link to this property
Link to this property
p95: optional object {lower, upper }
Upper and lower bound for percentile estimate
lower: optional number
Lower bound for percentile estimate
Link to this property
upper: optional number
Upper bound for percentile estimate
Link to this property
Link to this property
p99: optional object {lower, upper }
Upper and lower bound for percentile estimate
lower: optional number
Lower bound for percentile estimate
Link to this property
upper: optional number
Upper bound for percentile estimate
Link to this property
Link to this property
Link to this property
mean: optional number
Suggested threshold.
Link to this property
Link to this property
Link to this property
Link to this property
APIShieldOperationFeatureSchemaInfo object {schema\_info }
schema\_info: optional object {active\_schema, mitigation\_action }
active\_schema: optional object {id, created\_at, name }
Schema active on endpoint.
id: optional string
UUID.
maxLength36
minLength36
Link to this property
created\_at: optional string
formatdate-time
Link to this property
name: optional string
Schema file name.
Link to this property
Link to this property
mitigation\_action: optional "none"or "log"or "block"
Action taken on requests failing validation.
One of the following:
"none"
Link to this property
"log"
Link to this property
"block"
Link to this property
Link to this property
Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: true
Whether the API call was successful.
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result\_info: optional object {count, page, per\_page, 2 more }
count: optional number
Total number of results for the requested service.
Link to this property
page: optional number
Current page within paginated list of results.
Link to this property
per\_page: optional number
Number of results per page of results.
Link to this property
total\_count: optional number
Total results available without any search parameters.
Link to this property
total\_pages: optional number
The number of total pages in the entire result set.
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>)
### List web and API operations
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/api_gateway/operations \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
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"
}
}
}
],
"success": true,
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000,
"total_pages": 100
}
}
```
##### 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"
}
}
}
],
"success": true,
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000,
"total_pages": 100
}
}
```