--- title: API Gateway --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # API Gateway #### API GatewayConfigurations ##### [Get session identifier settings](https://developers.cloudflare.com/api/resources/api_gateway/subresources/configurations/methods/get) GET/zones/{zone\_id}/api\_gateway/configuration ##### [Update session identifier settings](https://developers.cloudflare.com/api/resources/api_gateway/subresources/configurations/methods/update) PUT/zones/{zone\_id}/api\_gateway/configuration ##### ModelsExpand Collapse

Configuration object {auth\_id\_characteristics }

auth\_id\_characteristics: array of object {name, type } or object {name, type }

One of the following:

APIShieldAuthIDCharacteristic object {name, type } Auth ID Characteristic

name: string The name of the characteristic field, i.e., the header or cookie name. maxLength128 Link to this property

type: "header"or "cookie" The type of characteristic.

One of the following: "header" Link to this property "cookie" Link to this property

Link to this property

APIShieldAuthIDCharacteristicJWTClaim object {name, type } Auth ID Characteristic extracted from JWT Token Claims

name: string Claim location expressed as $(token_config_id):$(json_path), where token_config_id is the ID of the token configuration used in validating the JWT, and json_path is a RFC 9535 JSONPath (https://goessner.net/articles/JsonPath/, https://www.rfc-editor.org/rfc/rfc9535.html). The JSONPath expression may be in dot or bracket notation, may only specify literal keys or array indexes, and must return a singleton value, which will be interpreted as a string. maxLength128 Link to this property type: "jwt" The type of characteristic. Link to this property

Link to this property

[Link to this property](<#(resource)%20api_gateway.configurations%20%3E%20(model)%20configuration%20%3E%20(schema)>) #### API GatewayDiscovery ##### [Export discovered API operations as OpenAPI schemas](https://developers.cloudflare.com/api/resources/api_gateway/subresources/discovery/methods/get) GET/zones/{zone\_id}/api\_gateway/discovery ##### ModelsExpand Collapse

DiscoveryOperation object {id, endpoint, host, 5 more }

id: string UUID. maxLength36 minLength36 Link to this property 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

origin: array of "ML"or "SessionIdentifier"or "LabelDiscovery" API discovery engine(s) that discovered this operation

One of the following: "ML" Link to this property "SessionIdentifier" Link to this property "LabelDiscovery" Link to this property

Link to this property

state: "review"or "saved"or "ignored" State of operation in API Discovery - review - Operation is not saved into API Shield Endpoint Management - saved - Operation is saved into API Shield Endpoint Management - ignored - Operation is marked as ignored

One of the following: "review" Link to this property "saved" Link to this property "ignored" Link to this property

Link to this property

features: optional object {traffic\_stats }

traffic\_stats: optional object {last\_updated, period\_seconds, requests }

last\_updated: string formatdate-time Link to this property period\_seconds: number The period in seconds these statistics were computed over Link to this property requests: number The average number of requests seen during this period formatfloat Link to this property

Link to this property

[Link to this property](<#(resource)%20api_gateway.discovery%20%3E%20(model)%20discovery_operation%20%3E%20(schema)>)

DiscoveryGetResponse object {schemas, timestamp }

schemas: array of unknown Link to this property timestamp: string formatdate-time Link to this property

[Link to this property](<#(resource)%20api_gateway.discovery%20%3E%20(model)%20discovery_get_response%20%3E%20(schema)>) #### API GatewayDiscoveryOperations ##### [List discovered web and API operations](https://developers.cloudflare.com/api/resources/api_gateway/subresources/discovery/subresources/operations/methods/list) GET/zones/{zone\_id}/api\_gateway/discovery/operations ##### [Edit discovered web and API operations](https://developers.cloudflare.com/api/resources/api_gateway/subresources/discovery/subresources/operations/methods/bulk_edit) PATCH/zones/{zone\_id}/api\_gateway/discovery/operations ##### ModelsExpand Collapse

OperationBulkEditResponse = map\[object {state } ]

state: optional "review"or "ignored" Mark state of operation in API Discovery - review - Mark operation as for review - ignored - Mark operation as ignored

One of the following: "review" Link to this property "ignored" Link to this property

Link to this property

[Link to this property](<#(resource)%20api_gateway.discovery.operations%20%3E%20(model)%20operation_bulk_edit_response%20%3E%20(schema)>) #### API GatewayLabels ##### [List operation labels](https://developers.cloudflare.com/api/resources/api_gateway/subresources/labels/methods/list) GET/zones/{zone\_id}/api\_gateway/labels ##### ModelsExpand Collapse

LabelListResponse object {created\_at, description, last\_updated, 4 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 mapped\_resources: optional unknown Provides counts of what resources are linked to this label Link to this property

[Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(model)%20label_list_response%20%3E%20(schema)>) #### API GatewayLabelsUser ##### [Create user-defined operation labels](https://developers.cloudflare.com/api/resources/api_gateway/subresources/labels/subresources/user/methods/bulk_create) POST/zones/{zone\_id}/api\_gateway/labels/user ##### [Delete user-defined operation labels](https://developers.cloudflare.com/api/resources/api_gateway/subresources/labels/subresources/user/methods/bulk_delete) DELETE/zones/{zone\_id}/api\_gateway/labels/user ##### [Get a user-defined operation label](https://developers.cloudflare.com/api/resources/api_gateway/subresources/labels/subresources/user/methods/get) GET/zones/{zone\_id}/api\_gateway/labels/user/{name} ##### [Update a user-defined operation label](https://developers.cloudflare.com/api/resources/api_gateway/subresources/labels/subresources/user/methods/update) PUT/zones/{zone\_id}/api\_gateway/labels/user/{name} ##### [Edit a user-defined operation label](https://developers.cloudflare.com/api/resources/api_gateway/subresources/labels/subresources/user/methods/edit) PATCH/zones/{zone\_id}/api\_gateway/labels/user/{name} ##### [Delete a user-defined operation label](https://developers.cloudflare.com/api/resources/api_gateway/subresources/labels/subresources/user/methods/delete) DELETE/zones/{zone\_id}/api\_gateway/labels/user/{name} ##### ModelsExpand Collapse

UserBulkCreateResponse object {created\_at, description, last\_updated, 3 more }

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](<#(resource)%20api_gateway.labels.user%20%3E%20(model)%20user_bulk_create_response%20%3E%20(schema)>)

UserBulkDeleteResponse object {created\_at, description, last\_updated, 3 more }

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](<#(resource)%20api_gateway.labels.user%20%3E%20(model)%20user_bulk_delete_response%20%3E%20(schema)>)

UserGetResponse object {created\_at, description, last\_updated, 4 more }

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 mapped\_resources: optional unknown Provides counts of what resources are linked to this label Link to this property

[Link to this property](<#(resource)%20api_gateway.labels.user%20%3E%20(model)%20user_get_response%20%3E%20(schema)>)

UserUpdateResponse object {created\_at, description, last\_updated, 3 more }

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](<#(resource)%20api_gateway.labels.user%20%3E%20(model)%20user_update_response%20%3E%20(schema)>)

UserEditResponse object {created\_at, description, last\_updated, 3 more }

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](<#(resource)%20api_gateway.labels.user%20%3E%20(model)%20user_edit_response%20%3E%20(schema)>)

UserDeleteResponse object {created\_at, description, last\_updated, 3 more }

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](<#(resource)%20api_gateway.labels.user%20%3E%20(model)%20user_delete_response%20%3E%20(schema)>) #### API GatewayLabelsUserResources #### API GatewayLabelsUserResourcesOperation ##### [Replace operations attached to a user-defined label](https://developers.cloudflare.com/api/resources/api_gateway/subresources/labels/subresources/user/subresources/resources/subresources/operation/methods/update) PUT/zones/{zone\_id}/api\_gateway/labels/user/{name}/resources/operation ##### ModelsExpand Collapse

OperationUpdateResponse object {created\_at, description, last\_updated, 4 more }

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 mapped\_resources: optional unknown Provides counts of what resources are linked to this label Link to this property

[Link to this property](<#(resource)%20api_gateway.labels.user.resources.operation%20%3E%20(model)%20operation_update_response%20%3E%20(schema)>) #### API GatewayLabelsManaged ##### [Get a managed operation label](https://developers.cloudflare.com/api/resources/api_gateway/subresources/labels/subresources/managed/methods/get) GET/zones/{zone\_id}/api\_gateway/labels/managed/{name} ##### ModelsExpand Collapse

ManagedGetResponse object {created\_at, description, last\_updated, 4 more }

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 mapped\_resources: optional unknown Provides counts of what resources are linked to this label Link to this property

[Link to this property](<#(resource)%20api_gateway.labels.managed%20%3E%20(model)%20managed_get_response%20%3E%20(schema)>) #### API GatewayLabelsManagedResources #### API GatewayLabelsManagedResourcesOperation ##### [Replace operations attached to a managed label](https://developers.cloudflare.com/api/resources/api_gateway/subresources/labels/subresources/managed/subresources/resources/subresources/operation/methods/update) PUT/zones/{zone\_id}/api\_gateway/labels/managed/{name}/resources/operation ##### ModelsExpand Collapse

OperationUpdateResponse object {created\_at, description, last\_updated, 4 more }

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 mapped\_resources: optional unknown Provides counts of what resources are linked to this label Link to this property

[Link to this property](<#(resource)%20api_gateway.labels.managed.resources.operation%20%3E%20(model)%20operation_update_response%20%3E%20(schema)>) #### API GatewayOperations ##### [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.

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 }

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

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

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

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

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

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](<#(resource)%20api_gateway.operations%20%3E%20(model)%20operation_list_response%20%3E%20(schema)>)

OperationGetResponse object {endpoint, host, last\_updated, 4 more }

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

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 }

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.

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

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

APIShieldOperationFeatureSchemaInfo object {schema\_info }

schema\_info: optional object {active\_schema, mitigation\_action }

active\_schema: optional object {id, created\_at, name } Schema active on endpoint.

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

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.

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 }

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

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 }

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.

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

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

APIShieldOperationFeatureSchemaInfo object {schema\_info }

schema\_info: optional object {active\_schema, mitigation\_action }

active\_schema: optional object {id, created\_at, name } Schema active on endpoint.

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

schemas: optional object {learned, uploaded } OpenAPI JSON schemas for an operation, including both user-uploaded and Cloudflare-learned schemas.

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 }

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

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 }

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.

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

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

APIShieldOperationFeatureSchemaInfo object {schema\_info }

schema\_info: optional object {active\_schema, mitigation\_action }

active\_schema: optional object {id, created\_at, name } Schema active on endpoint.

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](<#(resource)%20api_gateway.operations%20%3E%20(model)%20operation_bulk_create_response%20%3E%20(schema)>)

OperationBulkDeleteResponse object {errors, messages, success }

[Link to this property](<#(resource)%20api_gateway.operations%20%3E%20(model)%20operation_bulk_delete_response%20%3E%20(schema)>) #### API GatewayOperationsLabels ##### [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 }

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

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 }

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](<#(resource)%20api_gateway.operations.labels%20%3E%20(model)%20label_update_response%20%3E%20(schema)>)

LabelCreateResponse object {endpoint, host, last\_updated, 3 more }

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

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 }

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](<#(resource)%20api_gateway.operations.labels%20%3E%20(model)%20label_create_response%20%3E%20(schema)>)

LabelDeleteResponse object {endpoint, host, last\_updated, 3 more }

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

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 }

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](<#(resource)%20api_gateway.operations.labels%20%3E%20(model)%20label_delete_response%20%3E%20(schema)>)

LabelBulkUpdateResponse object {endpoint, host, last\_updated, 3 more }

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

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 }

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](<#(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 }

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

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 }

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](<#(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 }

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

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 }

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](<#(resource)%20api_gateway.operations.labels%20%3E%20(model)%20label_bulk_delete_response%20%3E%20(schema)>) #### API GatewayOperationsSchema 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 }

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 }

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)>) #### API GatewaySchemas ##### [Export web and API operations as OpenAPI schemas](https://developers.cloudflare.com/api/resources/api_gateway/subresources/schemas/methods/list) GET/zones/{zone\_id}/api\_gateway/schemas ##### ModelsExpand Collapse

SchemaListResponse object {schemas, timestamp }

schemas: optional array of unknown Link to this property timestamp: optional string Link to this property

[Link to this property](<#(resource)%20api_gateway.schemas%20%3E%20(model)%20schema_list_response%20%3E%20(schema)>) #### API GatewaySettings ##### ModelsExpand Collapse

Settings object {validation\_default\_mitigation\_action, validation\_override\_mitigation\_action }

validation\_default\_mitigation\_action: optional "none"or "log"or "block" The default mitigation action used when there is no mitigation action defined on the operation Mitigation actions are as follows: - log - log request when request does not conform to schema - block - deny access to the site when request does not conform to schema A special value of of none will skip running schema validation entirely for the request when there is no mitigation action defined on the operation

One of the following: "none" Link to this property "log" Link to this property "block" Link to this property

Link to this property validation\_override\_mitigation\_action: optional "none" When set, this overrides both zone level and operation level mitigation actions. - none will skip running schema validation entirely for the request - null indicates that no override is in place Link to this property

[Link to this property](<#(resource)%20api_gateway.settings%20%3E%20(model)%20settings%20%3E%20(schema)>) #### API GatewaySettingsSchema Validation ##### [Retrieve zone level schema validation settings](https://developers.cloudflare.com/api/resources/api_gateway/subresources/settings/subresources/schema_validation/methods/get) Deprecated GET/zones/{zone\_id}/api\_gateway/settings/schema\_validation ##### [Update zone level schema validation settings](https://developers.cloudflare.com/api/resources/api_gateway/subresources/settings/subresources/schema_validation/methods/update) Deprecated PUT/zones/{zone\_id}/api\_gateway/settings/schema\_validation ##### [Update zone level schema validation settings](https://developers.cloudflare.com/api/resources/api_gateway/subresources/settings/subresources/schema_validation/methods/edit) Deprecated PATCH/zones/{zone\_id}/api\_gateway/settings/schema\_validation #### API GatewayUser Schemas ##### [Retrieve information about all schemas on a zone](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas/methods/list) Deprecated GET/zones/{zone\_id}/api\_gateway/user\_schemas ##### [Retrieve information about a specific schema on a zone](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas/methods/get) Deprecated GET/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id} ##### [Upload a legacy schema](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas/methods/create) Deprecated POST/zones/{zone\_id}/api\_gateway/user\_schemas ##### [Enable validation for a schema](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas/methods/edit) Deprecated PATCH/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id} ##### [Delete a schema](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas/methods/delete) Deprecated DELETE/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id} ##### ModelsExpand Collapse

Message = array of object {code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20message%20%3E%20(schema)>)

OldPublicSchema object {created\_at, kind, name, 3 more }

created\_at: string formatdate-time Link to this property kind: "openapi\_v3" Kind of schema Link to this property name: string Name of the schema Link to this property schema\_id: string UUID. maxLength36 minLength36 Link to this property source: optional string Source of the schema Link to this property validation\_enabled: optional boolean Flag whether schema is enabled for validation. Link to this property

[Link to this property](<#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20old_public_schema%20%3E%20(schema)>)

UserSchemaCreateResponse object {schema, upload\_details }

schema: OldPublicSchema { created\_at, kind, name, 3 more } Link to this property

upload\_details: optional object {warnings }

warnings: optional array of object {code, locations, message } Diagnostic warning events that occurred during processing. These events are non-critical errors found within the schema.

code: number Code that identifies the event that occurred. Link to this property locations: optional array of string JSONPath location(s) in the schema where these events were encountered. See https://goessner.net/articles/JsonPath/ for JSONPath specification. Link to this property message: optional string Diagnostic message that describes the event. Link to this property

Link to this property

[Link to this property](<#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20user_schema_create_response%20%3E%20(schema)>)

UserSchemaDeleteResponse object {errors, messages, success }

[Link to this property](<#(resource)%20api_gateway.user_schemas%20%3E%20(model)%20user_schema_delete_response%20%3E%20(schema)>) #### API GatewayUser SchemasOperations ##### [Retrieve all operations from a schema](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas/subresources/operations/methods/list) Deprecated GET/zones/{zone\_id}/api\_gateway/user\_schemas/{schema\_id}/operations ##### ModelsExpand Collapse

OperationListResponse = object {endpoint, host, last\_updated, 3 more } or object {endpoint, host, method }

One of the following:

APIShieldOperation object {endpoint, host, last\_updated, 3 more }

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

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 }

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.

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

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

APIShieldOperationFeatureSchemaInfo object {schema\_info }

schema\_info: optional object {active\_schema, mitigation\_action }

active\_schema: optional object {id, created\_at, name } Schema active on endpoint.

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

APIShieldBasicOperation object {endpoint, host, method }

method: "GET"or "POST"or "HEAD"or 6 more The HTTP method used to access the endpoint.

Link to this property

[Link to this property](<#(resource)%20api_gateway.user_schemas.operations%20%3E%20(model)%20operation_list_response%20%3E%20(schema)>) #### API GatewayUser SchemasHosts ##### [Retrieve schema hosts in a zone](https://developers.cloudflare.com/api/resources/api_gateway/subresources/user_schemas/subresources/hosts/methods/list) Deprecated GET/zones/{zone\_id}/api\_gateway/user\_schemas/hosts ##### ModelsExpand Collapse

HostListResponse object {created\_at, hosts, name, schema\_id }

created\_at: string formatdate-time Link to this property hosts: array of string Hosts serving the schema, e.g zone.host.com Link to this property name: string Name of the schema Link to this property schema\_id: string UUID. maxLength36 minLength36 Link to this property

[Link to this property](<#(resource)%20api_gateway.user_schemas.hosts%20%3E%20(model)%20host_list_response%20%3E%20(schema)>) #### API GatewayExpression Template #### API GatewayExpression TemplateFallthrough ##### [Generate a fallthrough WAF expression template](https://developers.cloudflare.com/api/resources/api_gateway/subresources/expression_template/subresources/fallthrough/methods/create) Deprecated POST/zones/{zone\_id}/api\_gateway/expression-template/fallthrough ##### ModelsExpand Collapse

FallthroughCreateResponse object {expression, title }

expression: string WAF Expression for fallthrough Link to this property title: string Title for the expression Link to this property

[Link to this property](<#(resource)%20api_gateway.expression_template.fallthrough%20%3E%20(model)%20fallthrough_create_response%20%3E%20(schema)>)