--- title: Operations --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [API Gateway](https://developers.cloudflare.com/api/typescript/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/typescript/resources/api_gateway/subresources/operations/methods/list) client.apiGateway.operations.list(OperationListParams {zone\_id, direction, endpoint, 6 more } params, RequestOptionsoptions?): V4PagePaginationArray< [OperationListResponse]() {endpoint, host, last\_updated, 3 more } > GET/zones/{zone\_id}/api\_gateway/operations ##### [Get a web or API operation](https://developers.cloudflare.com/api/typescript/resources/api_gateway/subresources/operations/methods/get) client.apiGateway.operations.get(stringoperationID, OperationGetParams {zone\_id, feature, with\_schemas } params, RequestOptionsoptions?): [OperationGetResponse]() {endpoint, host, last\_updated, 4 more } GET/zones/{zone\_id}/api\_gateway/operations/{operation\_id} ##### [Create a web or API operation](https://developers.cloudflare.com/api/typescript/resources/api_gateway/subresources/operations/methods/create) client.apiGateway.operations.create(OperationCreateParams {zone\_id, endpoint, host, method } params, RequestOptionsoptions?): [OperationCreateResponse]() {endpoint, host, last\_updated, 4 more } POST/zones/{zone\_id}/api\_gateway/operations/item ##### [Delete a web or API operation](https://developers.cloudflare.com/api/typescript/resources/api_gateway/subresources/operations/methods/delete) client.apiGateway.operations.delete(stringoperationID, OperationDeleteParams {zone\_id } params, RequestOptionsoptions?): [OperationDeleteResponse]() {errors, messages, success } DELETE/zones/{zone\_id}/api\_gateway/operations/{operation\_id} ##### [Create web or API operations](https://developers.cloudflare.com/api/typescript/resources/api_gateway/subresources/operations/methods/bulk_create) client.apiGateway.operations.bulkCreate(OperationBulkCreateParams {zone\_id, body } params, RequestOptionsoptions?): SinglePage< [OperationBulkCreateResponse]() {endpoint, host, last\_updated, 3 more } > POST/zones/{zone\_id}/api\_gateway/operations ##### [Delete web or API operations](https://developers.cloudflare.com/api/typescript/resources/api_gateway/subresources/operations/methods/bulk_delete) client.apiGateway.operations.bulkDelete(OperationBulkDeleteParams {zone\_id } params, RequestOptionsoptions?): [OperationBulkDeleteResponse]() {errors, messages, success } DELETE/zones/{zone\_id}/api\_gateway/operations ##### ModelsExpand Collapse
APIShield {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"| "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: 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 {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"| "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: string UUID. maxLength36 minLength36 Link to this property
features?: APIShieldOperationFeatureThresholds {thresholds } | APIShieldOperationFeatureParameterSchemas {parameter\_schemas } | APIShieldOperationFeatureAPIRouting {api\_routing } | 2 more One of the following:
APIShieldOperationFeatureThresholds {thresholds }
thresholds?: Thresholds {auth\_id\_tokens, data\_points, last\_updated, 6 more } auth\_id\_tokens?: number The total number of auth-ids seen across this calculation. Link to this property data\_points?: number The number of data points used for the threshold suggestion calculation. Link to this property last\_updated?: string formatdate-time Link to this property p50?: number The p50 quantile of requests (in period\_seconds). Link to this property p90?: number The p90 quantile of requests (in period\_seconds). Link to this property p99?: number The p99 quantile of requests (in period\_seconds). Link to this property period\_seconds?: number The period over which this threshold is suggested. Link to this property requests?: number The estimated number of requests covered by these calculations. Link to this property suggested\_threshold?: 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 {parameter\_schemas }
parameter\_schemas: ParameterSchemas {last\_updated, parameter\_schemas } last\_updated?: string formatdate-time Link to this property
parameter\_schemas?: ParameterSchemas {parameters, responses } An operation schema object containing a response. parameters?: Array<unknown> An array containing the learned parameter schemas. Link to this property responses?: 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 {api\_routing }
api\_routing?: APIRouting {last\_updated, route } API Routing settings on endpoint. last\_updated?: string formatdate-time Link to this property route?: string Target route. Link to this property
Link to this property
Link to this property
APIShieldOperationFeatureConfidenceIntervals {confidence\_intervals }
confidence\_intervals?: ConfidenceIntervals {last\_updated, suggested\_threshold } last\_updated?: string formatdate-time Link to this property
suggested\_threshold?: SuggestedThreshold {confidence\_intervals, mean }
confidence\_intervals?: ConfidenceIntervals {p90, p95, p99 }
p90?: P90 {lower, upper } Upper and lower bound for percentile estimate lower?: number Lower bound for percentile estimate Link to this property upper?: number Upper bound for percentile estimate Link to this property
Link to this property
p95?: P95 {lower, upper } Upper and lower bound for percentile estimate lower?: number Lower bound for percentile estimate Link to this property upper?: number Upper bound for percentile estimate Link to this property
Link to this property
p99?: P99 {lower, upper } Upper and lower bound for percentile estimate lower?: number Lower bound for percentile estimate Link to this property upper?: number Upper bound for percentile estimate Link to this property
Link to this property
Link to this property mean?: number Suggested threshold. Link to this property
Link to this property
Link to this property
Link to this property
APIShieldOperationFeatureSchemaInfo {schema\_info }
schema\_info?: SchemaInfo {active\_schema, mitigation\_action }
active\_schema?: ActiveSchema {id, created\_at, name } Schema active on endpoint. id?: string UUID. maxLength36 minLength36 Link to this property created\_at?: string formatdate-time Link to this property name?: string Schema file name. Link to this property
Link to this property
mitigation\_action?: "none"| "log"| "block"| null 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 {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"| "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: string UUID. maxLength36 minLength36 Link to this property
features?: APIShieldOperationFeatureThresholds {thresholds } | APIShieldOperationFeatureParameterSchemas {parameter\_schemas } | APIShieldOperationFeatureAPIRouting {api\_routing } | 2 more One of the following:
APIShieldOperationFeatureThresholds {thresholds }
thresholds?: Thresholds {auth\_id\_tokens, data\_points, last\_updated, 6 more } auth\_id\_tokens?: number The total number of auth-ids seen across this calculation. Link to this property data\_points?: number The number of data points used for the threshold suggestion calculation. Link to this property last\_updated?: string formatdate-time Link to this property p50?: number The p50 quantile of requests (in period\_seconds). Link to this property p90?: number The p90 quantile of requests (in period\_seconds). Link to this property p99?: number The p99 quantile of requests (in period\_seconds). Link to this property period\_seconds?: number The period over which this threshold is suggested. Link to this property requests?: number The estimated number of requests covered by these calculations. Link to this property suggested\_threshold?: 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 {parameter\_schemas }
parameter\_schemas: ParameterSchemas {last\_updated, parameter\_schemas } last\_updated?: string formatdate-time Link to this property
parameter\_schemas?: ParameterSchemas {parameters, responses } An operation schema object containing a response. parameters?: Array<unknown> An array containing the learned parameter schemas. Link to this property responses?: 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 {api\_routing }
api\_routing?: APIRouting {last\_updated, route } API Routing settings on endpoint. last\_updated?: string formatdate-time Link to this property route?: string Target route. Link to this property
Link to this property
Link to this property
APIShieldOperationFeatureConfidenceIntervals {confidence\_intervals }
confidence\_intervals?: ConfidenceIntervals {last\_updated, suggested\_threshold } last\_updated?: string formatdate-time Link to this property
suggested\_threshold?: SuggestedThreshold {confidence\_intervals, mean }
confidence\_intervals?: ConfidenceIntervals {p90, p95, p99 }
p90?: P90 {lower, upper } Upper and lower bound for percentile estimate lower?: number Lower bound for percentile estimate Link to this property upper?: number Upper bound for percentile estimate Link to this property
Link to this property
p95?: P95 {lower, upper } Upper and lower bound for percentile estimate lower?: number Lower bound for percentile estimate Link to this property upper?: number Upper bound for percentile estimate Link to this property
Link to this property
p99?: P99 {lower, upper } Upper and lower bound for percentile estimate lower?: number Lower bound for percentile estimate Link to this property upper?: number Upper bound for percentile estimate Link to this property
Link to this property
Link to this property mean?: number Suggested threshold. Link to this property
Link to this property
Link to this property
Link to this property
APIShieldOperationFeatureSchemaInfo {schema\_info }
schema\_info?: SchemaInfo {active\_schema, mitigation\_action }
active\_schema?: ActiveSchema {id, created\_at, name } Schema active on endpoint. id?: string UUID. maxLength36 minLength36 Link to this property created\_at?: string formatdate-time Link to this property name?: string Schema file name. Link to this property
Link to this property
mitigation\_action?: "none"| "log"| "block"| null 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?: Schemas {learned, uploaded } OpenAPI JSON schemas for an operation, including both user-uploaded and Cloudflare-learned schemas.
learned?: Learned| null An OpenAPI operation object fragment containing schema information for an operation. May include parameter definitions, request body specifications, and a component schema extension. parameters?: Array<Record<string, unknown>> OpenAPI parameter objects describing path, query, header, or cookie parameters. Link to this property requestBody?: Record<string, unknown> OpenAPI request body object describing the expected request payload. Link to this property
Link to this property
uploaded?: Uploaded| null An OpenAPI operation object fragment containing schema information for an operation. May include parameter definitions, request body specifications, and a component schema extension. parameters?: Array<Record<string, unknown>> OpenAPI parameter objects describing path, query, header, or cookie parameters. Link to this property requestBody?: Record<string, 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 {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"| "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: string UUID. maxLength36 minLength36 Link to this property
features?: APIShieldOperationFeatureThresholds {thresholds } | APIShieldOperationFeatureParameterSchemas {parameter\_schemas } | APIShieldOperationFeatureAPIRouting {api\_routing } | 2 more One of the following:
APIShieldOperationFeatureThresholds {thresholds }
thresholds?: Thresholds {auth\_id\_tokens, data\_points, last\_updated, 6 more } auth\_id\_tokens?: number The total number of auth-ids seen across this calculation. Link to this property data\_points?: number The number of data points used for the threshold suggestion calculation. Link to this property last\_updated?: string formatdate-time Link to this property p50?: number The p50 quantile of requests (in period\_seconds). Link to this property p90?: number The p90 quantile of requests (in period\_seconds). Link to this property p99?: number The p99 quantile of requests (in period\_seconds). Link to this property period\_seconds?: number The period over which this threshold is suggested. Link to this property requests?: number The estimated number of requests covered by these calculations. Link to this property suggested\_threshold?: 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 {parameter\_schemas }
parameter\_schemas: ParameterSchemas {last\_updated, parameter\_schemas } last\_updated?: string formatdate-time Link to this property
parameter\_schemas?: ParameterSchemas {parameters, responses } An operation schema object containing a response. parameters?: Array<unknown> An array containing the learned parameter schemas. Link to this property responses?: 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 {api\_routing }
api\_routing?: APIRouting {last\_updated, route } API Routing settings on endpoint. last\_updated?: string formatdate-time Link to this property route?: string Target route. Link to this property
Link to this property
Link to this property
APIShieldOperationFeatureConfidenceIntervals {confidence\_intervals }
confidence\_intervals?: ConfidenceIntervals {last\_updated, suggested\_threshold } last\_updated?: string formatdate-time Link to this property
suggested\_threshold?: SuggestedThreshold {confidence\_intervals, mean }
confidence\_intervals?: ConfidenceIntervals {p90, p95, p99 }
p90?: P90 {lower, upper } Upper and lower bound for percentile estimate lower?: number Lower bound for percentile estimate Link to this property upper?: number Upper bound for percentile estimate Link to this property
Link to this property
p95?: P95 {lower, upper } Upper and lower bound for percentile estimate lower?: number Lower bound for percentile estimate Link to this property upper?: number Upper bound for percentile estimate Link to this property
Link to this property
p99?: P99 {lower, upper } Upper and lower bound for percentile estimate lower?: number Lower bound for percentile estimate Link to this property upper?: number Upper bound for percentile estimate Link to this property
Link to this property
Link to this property mean?: number Suggested threshold. Link to this property
Link to this property
Link to this property
Link to this property
APIShieldOperationFeatureSchemaInfo {schema\_info }
schema\_info?: SchemaInfo {active\_schema, mitigation\_action }
active\_schema?: ActiveSchema {id, created\_at, name } Schema active on endpoint. id?: string UUID. maxLength36 minLength36 Link to this property created\_at?: string formatdate-time Link to this property name?: string Schema file name. Link to this property
Link to this property
mitigation\_action?: "none"| "log"| "block"| null 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?: Schemas {learned, uploaded } OpenAPI JSON schemas for an operation, including both user-uploaded and Cloudflare-learned schemas.
learned?: Learned| null An OpenAPI operation object fragment containing schema information for an operation. May include parameter definitions, request body specifications, and a component schema extension. parameters?: Array<Record<string, unknown>> OpenAPI parameter objects describing path, query, header, or cookie parameters. Link to this property requestBody?: Record<string, unknown> OpenAPI request body object describing the expected request payload. Link to this property
Link to this property
uploaded?: Uploaded| null An OpenAPI operation object fragment containing schema information for an operation. May include parameter definitions, request body specifications, and a component schema extension. parameters?: Array<Record<string, unknown>> OpenAPI parameter objects describing path, query, header, or cookie parameters. Link to this property requestBody?: Record<string, 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 {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 {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"| "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: string UUID. maxLength36 minLength36 Link to this property
features?: APIShieldOperationFeatureThresholds {thresholds } | APIShieldOperationFeatureParameterSchemas {parameter\_schemas } | APIShieldOperationFeatureAPIRouting {api\_routing } | 2 more One of the following:
APIShieldOperationFeatureThresholds {thresholds }
thresholds?: Thresholds {auth\_id\_tokens, data\_points, last\_updated, 6 more } auth\_id\_tokens?: number The total number of auth-ids seen across this calculation. Link to this property data\_points?: number The number of data points used for the threshold suggestion calculation. Link to this property last\_updated?: string formatdate-time Link to this property p50?: number The p50 quantile of requests (in period\_seconds). Link to this property p90?: number The p90 quantile of requests (in period\_seconds). Link to this property p99?: number The p99 quantile of requests (in period\_seconds). Link to this property period\_seconds?: number The period over which this threshold is suggested. Link to this property requests?: number The estimated number of requests covered by these calculations. Link to this property suggested\_threshold?: 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 {parameter\_schemas }
parameter\_schemas: ParameterSchemas {last\_updated, parameter\_schemas } last\_updated?: string formatdate-time Link to this property
parameter\_schemas?: ParameterSchemas {parameters, responses } An operation schema object containing a response. parameters?: Array<unknown> An array containing the learned parameter schemas. Link to this property responses?: 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 {api\_routing }
api\_routing?: APIRouting {last\_updated, route } API Routing settings on endpoint. last\_updated?: string formatdate-time Link to this property route?: string Target route. Link to this property
Link to this property
Link to this property
APIShieldOperationFeatureConfidenceIntervals {confidence\_intervals }
confidence\_intervals?: ConfidenceIntervals {last\_updated, suggested\_threshold } last\_updated?: string formatdate-time Link to this property
suggested\_threshold?: SuggestedThreshold {confidence\_intervals, mean }
confidence\_intervals?: ConfidenceIntervals {p90, p95, p99 }
p90?: P90 {lower, upper } Upper and lower bound for percentile estimate lower?: number Lower bound for percentile estimate Link to this property upper?: number Upper bound for percentile estimate Link to this property
Link to this property
p95?: P95 {lower, upper } Upper and lower bound for percentile estimate lower?: number Lower bound for percentile estimate Link to this property upper?: number Upper bound for percentile estimate Link to this property
Link to this property
p99?: P99 {lower, upper } Upper and lower bound for percentile estimate lower?: number Lower bound for percentile estimate Link to this property upper?: number Upper bound for percentile estimate Link to this property
Link to this property
Link to this property mean?: number Suggested threshold. Link to this property
Link to this property
Link to this property
Link to this property
APIShieldOperationFeatureSchemaInfo {schema\_info }
schema\_info?: SchemaInfo {active\_schema, mitigation\_action }
active\_schema?: ActiveSchema {id, created\_at, name } Schema active on endpoint. id?: string UUID. maxLength36 minLength36 Link to this property created\_at?: string formatdate-time Link to this property name?: string Schema file name. Link to this property
Link to this property
mitigation\_action?: "none"| "log"| "block"| null 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 {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/typescript/resources/api_gateway/subresources/operations/subresources/labels/methods/update) client.apiGateway.operations.labels.update(stringoperationID, LabelUpdateParams {zone\_id, managed, user } params, RequestOptionsoptions?): [LabelUpdateResponse]() {endpoint, host, last\_updated, 3 more } PUT/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/labels ##### [Attach labels to a web or API operation](https://developers.cloudflare.com/api/typescript/resources/api_gateway/subresources/operations/subresources/labels/methods/create) client.apiGateway.operations.labels.create(stringoperationID, LabelCreateParams {zone\_id, managed, user } params, RequestOptionsoptions?): [LabelCreateResponse]() {endpoint, host, last\_updated, 3 more } POST/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/labels ##### [Remove labels from a web or API operation](https://developers.cloudflare.com/api/typescript/resources/api_gateway/subresources/operations/subresources/labels/methods/delete) client.apiGateway.operations.labels.delete(stringoperationID, LabelDeleteParams {zone\_id } params, RequestOptionsoptions?): [LabelDeleteResponse]() {endpoint, host, last\_updated, 3 more } DELETE/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/labels ##### [Replace labels on web or API operations](https://developers.cloudflare.com/api/typescript/resources/api_gateway/subresources/operations/subresources/labels/methods/bulk_update) client.apiGateway.operations.labels.bulkUpdate(LabelBulkUpdateParams {zone\_id, managed, selector, user } params, RequestOptionsoptions?): SinglePage< [LabelBulkUpdateResponse]() {endpoint, host, last\_updated, 3 more } > PUT/zones/{zone\_id}/api\_gateway/operations/labels ##### [Attach labels to web or API operations](https://developers.cloudflare.com/api/typescript/resources/api_gateway/subresources/operations/subresources/labels/methods/bulk_create) client.apiGateway.operations.labels.bulkCreate(LabelBulkCreateParams {zone\_id, selector, managed, user } params, RequestOptionsoptions?): SinglePage< [LabelBulkCreateResponse]() {endpoint, host, last\_updated, 3 more } > POST/zones/{zone\_id}/api\_gateway/operations/labels ##### [Remove labels from web or API operations](https://developers.cloudflare.com/api/typescript/resources/api_gateway/subresources/operations/subresources/labels/methods/bulk_delete) client.apiGateway.operations.labels.bulkDelete(LabelBulkDeleteParams {zone\_id } params, RequestOptionsoptions?): SinglePage< [LabelBulkDeleteResponse]() {endpoint, host, last\_updated, 3 more } > DELETE/zones/{zone\_id}/api\_gateway/operations/labels ##### ModelsExpand Collapse
LabelUpdateResponse {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"| "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: string UUID. maxLength36 minLength36 Link to this property
labels?: Array<Label> 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"| "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 {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"| "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: string UUID. maxLength36 minLength36 Link to this property
labels?: Array<Label> 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"| "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 {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"| "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: string UUID. maxLength36 minLength36 Link to this property
labels?: Array<Label> 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"| "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 {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"| "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: string UUID. maxLength36 minLength36 Link to this property
labels?: Array<Label> 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"| "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 {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"| "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: string UUID. maxLength36 minLength36 Link to this property
labels?: Array<Label> 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"| "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 {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"| "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: string UUID. maxLength36 minLength36 Link to this property
labels?: Array<Label> 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"| "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/typescript/resources/api_gateway/subresources/operations/subresources/schema_validation/methods/get) Deprecated client.apiGateway.operations.schemaValidation.get(stringoperationID, SchemaValidationGetParams {zone\_id } params, RequestOptionsoptions?): [SchemaValidationGetResponse]() {mitigation\_action, operation\_id } GET/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/schema\_validation ##### [Update operation-level schema validation settings](https://developers.cloudflare.com/api/typescript/resources/api_gateway/subresources/operations/subresources/schema_validation/methods/update) Deprecated client.apiGateway.operations.schemaValidation.update(stringoperationID, SchemaValidationUpdateParams {zone\_id, mitigation\_action } params, RequestOptionsoptions?): [SchemaValidationUpdateResponse]() {mitigation\_action, operation\_id } PUT/zones/{zone\_id}/api\_gateway/operations/{operation\_id}/schema\_validation ##### [Update multiple operation-level schema validation settings](https://developers.cloudflare.com/api/typescript/resources/api_gateway/subresources/operations/subresources/schema_validation/methods/edit) Deprecated client.apiGateway.operations.schemaValidation.edit(SchemaValidationEditParams {zone\_id, settings\_multiple\_request } params, RequestOptionsoptions?): [SettingsMultipleRequest]() {mitigation\_action } PATCH/zones/{zone\_id}/api\_gateway/operations/schema\_validation ##### ModelsExpand Collapse
SettingsMultipleRequest = Record<string, item>
mitigation\_action?: "log"| "block"| "none"| null 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 {mitigation\_action, operation\_id }
mitigation\_action?: "log"| "block"| "none"| null 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?: 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 {mitigation\_action, operation\_id }
mitigation\_action?: "log"| "block"| "none"| null 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?: 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)>)