--- title: Create a web or API operation --- [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** # Create a web or API operation client.APIGateway.Operations.New(ctx, params) (\*[OperationNewResponse](), error) POST/zones/{zone\_id}/api\_gateway/operations/item Creates one web or API operation. The host, method, and path are normalized; an existing matching operation is returned instead of duplicated. ##### 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``Domain API Gateway` ##### ParametersExpand Collapse
params OperationNewParams ZoneID param.Field\[string] Path param: Identifier. maxLength32 Link to this property Endpoint param.Field\[string] Body param: 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 param.Field\[string] Body param: RFC3986-compliant host. formathostname maxLength255 Link to this property
Method param.Field\[OperationNewParamsMethod] Body param: The HTTP method used to access the endpoint. const OperationNewParamsMethodGet OperationNewParamsMethod = "GET" Link to this property const OperationNewParamsMethodPost OperationNewParamsMethod = "POST" Link to this property const OperationNewParamsMethodHead OperationNewParamsMethod = "HEAD" Link to this property const OperationNewParamsMethodOptions OperationNewParamsMethod = "OPTIONS" Link to this property const OperationNewParamsMethodPut OperationNewParamsMethod = "PUT" Link to this property const OperationNewParamsMethodDelete OperationNewParamsMethod = "DELETE" Link to this property const OperationNewParamsMethodConnect OperationNewParamsMethod = "CONNECT" Link to this property const OperationNewParamsMethodPatch OperationNewParamsMethod = "PATCH" Link to this property const OperationNewParamsMethodTrace OperationNewParamsMethod = "TRACE" Link to this property
Link to this property
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type OperationNewResponse 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 OperationNewResponseMethod The HTTP method used to access the endpoint. One of the following: const OperationNewResponseMethodGet OperationNewResponseMethod = "GET" Link to this property const OperationNewResponseMethodPost OperationNewResponseMethod = "POST" Link to this property const OperationNewResponseMethodHead OperationNewResponseMethod = "HEAD" Link to this property const OperationNewResponseMethodOptions OperationNewResponseMethod = "OPTIONS" Link to this property const OperationNewResponseMethodPut OperationNewResponseMethod = "PUT" Link to this property const OperationNewResponseMethodDelete OperationNewResponseMethod = "DELETE" Link to this property const OperationNewResponseMethodConnect OperationNewResponseMethod = "CONNECT" Link to this property const OperationNewResponseMethodPatch OperationNewResponseMethod = "PATCH" Link to this property const OperationNewResponseMethodTrace OperationNewResponseMethod = "TRACE" Link to this property
Link to this property OperationID string UUID. maxLength36 minLength36 Link to this property
Features OperationNewResponseFeaturesOptional One of the following:
type OperationNewResponseFeaturesAPIShieldOperationFeatureThresholds struct{…}
Thresholds OperationNewResponseFeaturesAPIShieldOperationFeatureThresholdsThresholdsOptional 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 OperationNewResponseFeaturesAPIShieldOperationFeatureParameterSchemas struct{…}
ParameterSchemas OperationNewResponseFeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemas LastUpdated TimeOptional formatdate-time Link to this property
ParameterSchemas OperationNewResponseFeaturesAPIShieldOperationFeatureParameterSchemasParameterSchemasParameterSchemasOptional 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 OperationNewResponseFeaturesAPIShieldOperationFeatureAPIRouting struct{…}
APIRouting OperationNewResponseFeaturesAPIShieldOperationFeatureAPIRoutingAPIRoutingOptional 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 OperationNewResponseFeaturesAPIShieldOperationFeatureConfidenceIntervals struct{…}
ConfidenceIntervals OperationNewResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsOptional LastUpdated TimeOptional formatdate-time Link to this property
SuggestedThreshold OperationNewResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdOptional
ConfidenceIntervals OperationNewResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsOptional
P90 OperationNewResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP90Optional 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 OperationNewResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP95Optional 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 OperationNewResponseFeaturesAPIShieldOperationFeatureConfidenceIntervalsConfidenceIntervalsSuggestedThresholdConfidenceIntervalsP99Optional 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 OperationNewResponseFeaturesAPIShieldOperationFeatureSchemaInfo struct{…}
SchemaInfo OperationNewResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoOptional
ActiveSchema OperationNewResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoActiveSchemaOptional 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 OperationNewResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationActionOptional Action taken on requests failing validation. One of the following: const OperationNewResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationActionNone OperationNewResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationAction = "none" Link to this property const OperationNewResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationActionLog OperationNewResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationAction = "log" Link to this property const OperationNewResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationActionBlock OperationNewResponseFeaturesAPIShieldOperationFeatureSchemaInfoSchemaInfoMitigationAction = "block" Link to this property
Link to this property
Link to this property
Link to this property
Link to this property
Schemas OperationNewResponseSchemasOptional OpenAPI JSON schemas for an operation, including both user-uploaded and Cloudflare-learned schemas.
Learned OperationNewResponseSchemasLearnedOptional An OpenAPI operation object fragment containing schema information for an operation. May include parameter definitions, request body specifications, and a component schema extension. Parameters \[]map\[string, unknown]Optional OpenAPI parameter objects describing path, query, header, or cookie parameters. Link to this property RequestBody map\[string, unknown]Optional OpenAPI request body object describing the expected request payload. Link to this property
Link to this property
Uploaded OperationNewResponseSchemasUploadedOptional An OpenAPI operation object fragment containing schema information for an operation. May include parameter definitions, request body specifications, and a component schema extension. Parameters \[]map\[string, unknown]Optional OpenAPI parameter objects describing path, query, header, or cookie parameters. Link to this property RequestBody map\[string, unknown]Optional 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)%20OperationNewResponse%20%3E%20(schema)>) ### Create a web or API operation 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"), ) operation, err := client.APIGateway.Operations.New(context.TODO(), api_gateway.OperationNewParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), Endpoint: cloudflare.F("/api/v1/users/{var1}"), Host: cloudflare.F("www.example.com"), Method: cloudflare.F(api_gateway.OperationNewParamsMethodGet), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", operation.OperationID) } ``` 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 } ```