---
title: Operations
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[API Gateway](https://developers.cloudflare.com/api/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/resources/api_gateway/subresources/operations/methods/list)
GET/zones/{zone\_id}/api\_gateway/operations
##### [Get a web or API operation](https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations/methods/get)
GET/zones/{zone\_id}/api\_gateway/operations/{operation\_id}
##### [Create a web or API operation](https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations/methods/create)
POST/zones/{zone\_id}/api\_gateway/operations/item
##### [Delete a web or API operation](https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations/methods/delete)
DELETE/zones/{zone\_id}/api\_gateway/operations/{operation\_id}
##### [Create web or API operations](https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations/methods/bulk_create)
POST/zones/{zone\_id}/api\_gateway/operations
##### [Delete web or API operations](https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations/methods/bulk_delete)
DELETE/zones/{zone\_id}/api\_gateway/operations
##### ModelsExpand Collapse
APIShield object {endpoint, host, last\_updated, 2 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
[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(model)%20api-shield%20%3E%20(schema)>)
OperationListResponse 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(model)%20operation_list_response%20%3E%20(schema)>)
OperationGetResponse object {endpoint, host, last\_updated, 4 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
schemas: optional object {learned, uploaded }
OpenAPI JSON schemas for an operation, including both user-uploaded and Cloudflare-learned schemas.
learned: optional object {parameters, requestBody }
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 array of map\[unknown]
OpenAPI parameter objects describing path, query, header, or cookie parameters.
Link to this property
requestBody: optional map\[unknown]
OpenAPI request body object describing the expected request payload.
Link to this property
Link to this property
uploaded: optional object {parameters, requestBody }
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 array of map\[unknown]
OpenAPI parameter objects describing path, query, header, or cookie parameters.
Link to this property
requestBody: optional map\[unknown]
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)>)
OperationCreateResponse object {endpoint, host, last\_updated, 4 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
schemas: optional object {learned, uploaded }
OpenAPI JSON schemas for an operation, including both user-uploaded and Cloudflare-learned schemas.
learned: optional object {parameters, requestBody }
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 array of map\[unknown]
OpenAPI parameter objects describing path, query, header, or cookie parameters.
Link to this property
requestBody: optional map\[unknown]
OpenAPI request body object describing the expected request payload.
Link to this property
Link to this property
uploaded: optional object {parameters, requestBody }
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 array of map\[unknown]
OpenAPI parameter objects describing path, query, header, or cookie parameters.
Link to this property
requestBody: optional map\[unknown]
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)>)
OperationDeleteResponse object {errors, messages, success }
errors: Message { code, message, documentation\_url, source }
Link to this property
messages: Message { code, message, documentation\_url, source }
Link to this property
success: 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)>)
OperationBulkCreateResponse 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(model)%20operation_bulk_create_response%20%3E%20(schema)>)
OperationBulkDeleteResponse object {errors, messages, success }
errors: Message { code, message, documentation\_url, source }
Link to this property
messages: Message { code, message, documentation\_url, source }
Link to this property
success: 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/resources/api_gateway/subresources/operations/subresources/labels/methods/update)
PUT/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/labels
##### [Attach labels to a web or API operation](https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations/subresources/labels/methods/create)
POST/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/labels
##### [Remove labels from a web or API operation](https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations/subresources/labels/methods/delete)
DELETE/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/labels
##### [Replace labels on web or API operations](https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations/subresources/labels/methods/bulk_update)
PUT/zones/{zone\_id}/api\_gateway/operations/labels
##### [Attach labels to web or API operations](https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations/subresources/labels/methods/bulk_create)
POST/zones/{zone\_id}/api\_gateway/operations/labels
##### [Remove labels from web or API operations](https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations/subresources/labels/methods/bulk_delete)
DELETE/zones/{zone\_id}/api\_gateway/operations/labels
##### ModelsExpand Collapse
LabelUpdateResponse 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
labels: optional array of object {created\_at, description, last\_updated, 3 more }
created\_at: string
formatdate-time
Link to this property
description: string
The description of the label
Link to this property
last\_updated: string
formatdate-time
Link to this property
metadata: unknown
Metadata for the label
Link to this property
name: string
The name of the label
Link to this property
source: "user"or "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)>)
LabelCreateResponse 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
labels: optional array of object {created\_at, description, last\_updated, 3 more }
created\_at: string
formatdate-time
Link to this property
description: string
The description of the label
Link to this property
last\_updated: string
formatdate-time
Link to this property
metadata: unknown
Metadata for the label
Link to this property
name: string
The name of the label
Link to this property
source: "user"or "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)>)
LabelDeleteResponse 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
labels: optional array of object {created\_at, description, last\_updated, 3 more }
created\_at: string
formatdate-time
Link to this property
description: string
The description of the label
Link to this property
last\_updated: string
formatdate-time
Link to this property
metadata: unknown
Metadata for the label
Link to this property
name: string
The name of the label
Link to this property
source: "user"or "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)>)
LabelBulkUpdateResponse 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
labels: optional array of object {created\_at, description, last\_updated, 3 more }
created\_at: string
formatdate-time
Link to this property
description: string
The description of the label
Link to this property
last\_updated: string
formatdate-time
Link to this property
metadata: unknown
Metadata for the label
Link to this property
name: string
The name of the label
Link to this property
source: "user"or "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)>)
LabelBulkCreateResponse 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
labels: optional array of object {created\_at, description, last\_updated, 3 more }
created\_at: string
formatdate-time
Link to this property
description: string
The description of the label
Link to this property
last\_updated: string
formatdate-time
Link to this property
metadata: unknown
Metadata for the label
Link to this property
name: string
The name of the label
Link to this property
source: "user"or "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)>)
LabelBulkDeleteResponse 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
labels: optional array of object {created\_at, description, last\_updated, 3 more }
created\_at: string
formatdate-time
Link to this property
description: string
The description of the label
Link to this property
last\_updated: string
formatdate-time
Link to this property
metadata: unknown
Metadata for the label
Link to this property
name: string
The name of the label
Link to this property
source: "user"or "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/resources/api_gateway/subresources/operations/subresources/schema_validation/methods/get)
Deprecated
GET/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/schema\_validation
##### [Update operation-level schema validation settings](https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations/subresources/schema_validation/methods/update)
Deprecated
PUT/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/schema\_validation
##### [Update multiple operation-level schema validation settings](https://developers.cloudflare.com/api/resources/api_gateway/subresources/operations/subresources/schema_validation/methods/edit)
Deprecated
PATCH/zones/{zone\_id}/api\_gateway/operations/schema\_validation
##### ModelsExpand Collapse
SettingsMultipleRequest = map\[object {mitigation\_action } ]
mitigation\_action: optional "log"or "block"or "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)>)
SchemaValidationGetResponse object {mitigation\_action, operation\_id }
mitigation\_action: optional "log"or "block"or "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 string
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)>)
SchemaValidationUpdateResponse object {mitigation\_action, operation\_id }
mitigation\_action: optional "log"or "block"or "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 string
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)>)