--- title: List web and API operations --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [API Gateway](https://developers.cloudflare.com/api/go/resources/api_gateway) [Operations](https://developers.cloudflare.com/api/go/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 client.APIGateway.Operations.List(ctx, params) (\*V4PagePaginationArray\[[OperationListResponse]()], error) 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` ##### ParametersExpand Collapse
params OperationListParams ZoneID param.Field\[string] Path param: Identifier. maxLength32 Link to this property
Direction param.Field\[OperationListParamsDirection]Optional Query param: Direction to order results. const OperationListParamsDirectionAsc OperationListParamsDirection = "asc" Link to this property const OperationListParamsDirectionDesc OperationListParamsDirection = "desc" Link to this property
Link to this property Endpoint param.Field\[string]Optional Query param: Filter results to only include endpoints containing this pattern. Link to this property
Feature param.Field\[\[]OperationListParamsFeature]Optional Query param: 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. const OperationListParamsFeatureThresholds OperationListParamsFeature = "thresholds" Link to this property const OperationListParamsFeatureParameterSchemas OperationListParamsFeature = "parameter\_schemas" Link to this property const OperationListParamsFeatureSchemaInfo OperationListParamsFeature = "schema\_info" Link to this property const OperationListParamsFeatureConfidenceIntervals OperationListParamsFeature = "confidence\_intervals" Link to this property
Link to this property Host param.Field\[\[]string]Optional Query param: Filter results to only include the specified hosts. Link to this property Method param.Field\[\[]string]Optional Query param: Filter results to only include the specified HTTP methods. Link to this property
Order param.Field\[OperationListParamsOrder]Optional Query param: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold. const OperationListParamsOrderMethod OperationListParamsOrder = "method" Link to this property const OperationListParamsOrderHost OperationListParamsOrder = "host" Link to this property const OperationListParamsOrderEndpoint OperationListParamsOrder = "endpoint" Link to this property const OperationListParamsOrderThresholdsKey OperationListParamsOrder = "thresholds.$key" Link to this property
Link to this property Page param.Field\[int64]Optional Query param: Page number of paginated results. minimum1 Link to this property PerPage param.Field\[int64]Optional Query param: Maximum number of results per page. maximum50 minimum5 Link to this property
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type OperationListResponse struct{…} 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 LastUpdated Time formatdate-time Link to this property
Method OperationListResponseMethod The HTTP method used to access the endpoint. One of the following: const OperationListResponseMethodGet OperationListResponseMethod = "GET" Link to this property const OperationListResponseMethodPost OperationListResponseMethod = "POST" Link to this property const OperationListResponseMethodHead OperationListResponseMethod = "HEAD" Link to this property const OperationListResponseMethodOptions OperationListResponseMethod = "OPTIONS" Link to this property const OperationListResponseMethodPut OperationListResponseMethod = "PUT" Link to this property const OperationListResponseMethodDelete OperationListResponseMethod = "DELETE" Link to this property const OperationListResponseMethodConnect OperationListResponseMethod = "CONNECT" Link to this property const OperationListResponseMethodPatch OperationListResponseMethod = "PATCH" Link to this property const OperationListResponseMethodTrace OperationListResponseMethod = "TRACE" Link to this property
Link to this property OperationID string UUID. maxLength36 minLength36 Link to this property
Features OperationListResponseFeaturesOptional One of the following:
type OperationListResponseFeaturesAPIShieldOperationFeatureThresholds struct{…}
Thresholds OperationListResponseFeaturesAPIShieldOperationFeatureThresholdsThresholdsOptional AuthIDTokens int64Optional The total number of auth-ids seen across this calculation. Link to this property DataPoints int64Optional The number of data points used for the threshold suggestion calculation. Link to this property LastUpdated TimeOptional formatdate-time Link to this property P50 int64Optional The p50 quantile of requests (in period\_seconds). Link to this property P90 int64Optional The p90 quantile of requests (in period\_seconds). Link to this property P99 int64Optional The p99 quantile of requests (in period\_seconds). Link to this property PeriodSeconds int64Optional The period over which this threshold is suggested. Link to this property Requests int64Optional The estimated number of requests covered by these calculations. Link to this property SuggestedThreshold int64Optional 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
type OperationListResponseFeaturesAPIShieldOperationFeatureParameterSchemas struct{…}
ParameterSchemas OperationListResponseFeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemas LastUpdated TimeOptional formatdate-time Link to this property
ParameterSchemas OperationListResponseFeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemasParameterSchemasOptional An operation schema object containing a response. Parameters \[]unknownOptional An array containing the learned parameter schemas. Link to this property Responses unknownOptional 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
type OperationListResponseFeaturesAPIShieldOperationFeatureAPIRouting struct{…}
APIRouting OperationListResponseFeaturesAPIShieldOperationFeatureAPIRoutingAPIRoutingOptional API Routing settings on endpoint. LastUpdated TimeOptional formatdate-time Link to this property Route stringOptional Target route. Link to this property
Link to this property
Link to this property
type OperationListResponseFeaturesAPIShieldOperationFeatureConfidenceIntervals struct{…}
ConfidenceIntervals OperationListResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsOptional LastUpdated TimeOptional formatdate-time Link to this property
SuggestedThreshold OperationListResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdOptional
ConfidenceIntervals OperationListResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsOptional
P90 OperationListResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90Optional Upper and lower bound for percentile estimate Lower float64Optional Lower bound for percentile estimate Link to this property Upper float64Optional Upper bound for percentile estimate Link to this property
Link to this property
P95 OperationListResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95Optional Upper and lower bound for percentile estimate Lower float64Optional Lower bound for percentile estimate Link to this property Upper float64Optional Upper bound for percentile estimate Link to this property
Link to this property
P99 OperationListResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99Optional Upper and lower bound for percentile estimate Lower float64Optional Lower bound for percentile estimate Link to this property Upper float64Optional Upper bound for percentile estimate Link to this property
Link to this property
Link to this property Mean float64Optional Suggested threshold. Link to this property
Link to this property
Link to this property
Link to this property
type OperationListResponseFeaturesAPIShieldOperationFeatureSchemaInfo struct{…}
SchemaInfo OperationListResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoOptional
ActiveSchema OperationListResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoActiveSchemaOptional Schema active on endpoint. ID stringOptional UUID. maxLength36 minLength36 Link to this property CreatedAt TimeOptional formatdate-time Link to this property Name stringOptional Schema file name. Link to this property
Link to this property
MitigationAction OperationListResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationActionOptional Action taken on requests failing validation. One of the following: const OperationListResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationActionNone OperationListResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationAction = "none" Link to this property const OperationListResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationActionLog OperationListResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationAction = "log" Link to this property const OperationListResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationActionBlock OperationListResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationAction = "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)%20OperationListResponse%20%3E%20(schema)>) ### List web and API operations Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/api_gateway" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.APIGateway.Operations.List(context.TODO(), api_gateway.OperationListParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 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 } } ```