API Reference

API Gateway

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Operations

List web and API operations

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

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

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

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

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

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

host: string

RFC3986-compliant host.

formathostname

maxLength255

last_updated: string

formatdate-time

method: "GET" | "POST" | "HEAD" | 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

operation_id: string

UUID.

maxLength36

minLength36

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

host: string

RFC3986-compliant host.

formathostname

maxLength255

last_updated: string

formatdate-time

method: "GET" | "POST" | "HEAD" | 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

operation_id: string

UUID.

maxLength36

minLength36

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.

data_points?: number

The number of data points used for the threshold suggestion calculation.

last_updated?: string

formatdate-time

p50?: number

The p50 quantile of requests (in period_seconds).

p90?: number

The p90 quantile of requests (in period_seconds).

p99?: number

The p99 quantile of requests (in period_seconds).

period_seconds?: number

The period over which this threshold is suggested.

requests?: number

The estimated number of requests covered by these calculations.

suggested_threshold?: number

The suggested threshold in requests done by the same auth_id or period_seconds.

APIShieldOperationFeatureParameterSchemas { parameter_schemas }

parameter_schemas: ParameterSchemas { last_updated, parameter_schemas }

last_updated?: string

formatdate-time

parameter_schemas?: ParameterSchemas { parameters, responses }

An operation schema object containing a response.

parameters?: Array<unknown>

An array containing the learned parameter schemas.

responses?: unknown

An empty response object. This field is required to yield a valid operation schema.

APIShieldOperationFeatureAPIRouting { api_routing }

api_routing?: APIRouting { last_updated, route }

API Routing settings on endpoint.

last_updated?: string

formatdate-time

route?: string

Target route.

APIShieldOperationFeatureConfidenceIntervals { confidence_intervals }

confidence_intervals?: ConfidenceIntervals { last_updated, suggested_threshold }

last_updated?: string

formatdate-time

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

upper?: number

Upper bound for percentile estimate

p95?: P95 { lower, upper }

Upper and lower bound for percentile estimate

lower?: number

Lower bound for percentile estimate

upper?: number

Upper bound for percentile estimate

p99?: P99 { lower, upper }

Upper and lower bound for percentile estimate

lower?: number

Lower bound for percentile estimate

upper?: number

Upper bound for percentile estimate

mean?: number

Suggested threshold.

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

created_at?: string

formatdate-time

name?: string

Schema file name.

mitigation_action?: "none" | "log" | "block" | null

Action taken on requests failing validation.

One of the following:

"none"

"log"

"block"

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

host: string

RFC3986-compliant host.

formathostname

maxLength255

last_updated: string

formatdate-time

method: "GET" | "POST" | "HEAD" | 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

operation_id: string

UUID.

maxLength36

minLength36

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.

data_points?: number

The number of data points used for the threshold suggestion calculation.

last_updated?: string

formatdate-time

p50?: number

The p50 quantile of requests (in period_seconds).

p90?: number

The p90 quantile of requests (in period_seconds).

p99?: number

The p99 quantile of requests (in period_seconds).

period_seconds?: number

The period over which this threshold is suggested.

requests?: number

The estimated number of requests covered by these calculations.

suggested_threshold?: number

The suggested threshold in requests done by the same auth_id or period_seconds.

APIShieldOperationFeatureParameterSchemas { parameter_schemas }

parameter_schemas: ParameterSchemas { last_updated, parameter_schemas }

last_updated?: string

formatdate-time

parameter_schemas?: ParameterSchemas { parameters, responses }

An operation schema object containing a response.

parameters?: Array<unknown>

An array containing the learned parameter schemas.

responses?: unknown

An empty response object. This field is required to yield a valid operation schema.

APIShieldOperationFeatureAPIRouting { api_routing }

api_routing?: APIRouting { last_updated, route }

API Routing settings on endpoint.

last_updated?: string

formatdate-time

route?: string

Target route.

APIShieldOperationFeatureConfidenceIntervals { confidence_intervals }

confidence_intervals?: ConfidenceIntervals { last_updated, suggested_threshold }

last_updated?: string

formatdate-time

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

upper?: number

Upper bound for percentile estimate

p95?: P95 { lower, upper }

Upper and lower bound for percentile estimate

lower?: number

Lower bound for percentile estimate

upper?: number

Upper bound for percentile estimate

p99?: P99 { lower, upper }

Upper and lower bound for percentile estimate

lower?: number

Lower bound for percentile estimate

upper?: number

Upper bound for percentile estimate

mean?: number

Suggested threshold.

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

created_at?: string

formatdate-time

name?: string

Schema file name.

mitigation_action?: "none" | "log" | "block" | null

Action taken on requests failing validation.

One of the following:

"none"

"log"

"block"

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.

requestBody?: Record<string, unknown>

OpenAPI request body object describing the expected request payload.

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.

requestBody?: Record<string, unknown>

OpenAPI request body object describing the expected request payload.

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

host: string

RFC3986-compliant host.

formathostname

maxLength255

last_updated: string

formatdate-time

method: "GET" | "POST" | "HEAD" | 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

operation_id: string

UUID.

maxLength36

minLength36

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.

data_points?: number

The number of data points used for the threshold suggestion calculation.

last_updated?: string

formatdate-time

p50?: number

The p50 quantile of requests (in period_seconds).

p90?: number

The p90 quantile of requests (in period_seconds).

p99?: number

The p99 quantile of requests (in period_seconds).

period_seconds?: number

The period over which this threshold is suggested.

requests?: number

The estimated number of requests covered by these calculations.

suggested_threshold?: number

The suggested threshold in requests done by the same auth_id or period_seconds.

APIShieldOperationFeatureParameterSchemas { parameter_schemas }

parameter_schemas: ParameterSchemas { last_updated, parameter_schemas }

last_updated?: string

formatdate-time

parameter_schemas?: ParameterSchemas { parameters, responses }

An operation schema object containing a response.

parameters?: Array<unknown>

An array containing the learned parameter schemas.

responses?: unknown

An empty response object. This field is required to yield a valid operation schema.

APIShieldOperationFeatureAPIRouting { api_routing }

api_routing?: APIRouting { last_updated, route }

API Routing settings on endpoint.

last_updated?: string

formatdate-time

route?: string

Target route.

APIShieldOperationFeatureConfidenceIntervals { confidence_intervals }

confidence_intervals?: ConfidenceIntervals { last_updated, suggested_threshold }

last_updated?: string

formatdate-time

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

upper?: number

Upper bound for percentile estimate

p95?: P95 { lower, upper }

Upper and lower bound for percentile estimate

lower?: number

Lower bound for percentile estimate

upper?: number

Upper bound for percentile estimate

p99?: P99 { lower, upper }

Upper and lower bound for percentile estimate

lower?: number

Lower bound for percentile estimate

upper?: number

Upper bound for percentile estimate

mean?: number

Suggested threshold.

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

created_at?: string

formatdate-time

name?: string

Schema file name.

mitigation_action?: "none" | "log" | "block" | null

Action taken on requests failing validation.

One of the following:

"none"

"log"

"block"

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.

requestBody?: Record<string, unknown>

OpenAPI request body object describing the expected request payload.

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.

requestBody?: Record<string, unknown>

OpenAPI request body object describing the expected request payload.

OperationDeleteResponse { errors, messages, success }

errors: Message { code, message, documentation_url, source }

messages: Message { code, message, documentation_url, source }

success: true

Whether the API call was successful.

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

host: string

RFC3986-compliant host.

formathostname

maxLength255

last_updated: string

formatdate-time

method: "GET" | "POST" | "HEAD" | 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

operation_id: string

UUID.

maxLength36

minLength36

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.

data_points?: number

The number of data points used for the threshold suggestion calculation.

last_updated?: string

formatdate-time

p50?: number

The p50 quantile of requests (in period_seconds).

p90?: number

The p90 quantile of requests (in period_seconds).

p99?: number

The p99 quantile of requests (in period_seconds).

period_seconds?: number

The period over which this threshold is suggested.

requests?: number

The estimated number of requests covered by these calculations.

suggested_threshold?: number

The suggested threshold in requests done by the same auth_id or period_seconds.

APIShieldOperationFeatureParameterSchemas { parameter_schemas }

parameter_schemas: ParameterSchemas { last_updated, parameter_schemas }

last_updated?: string

formatdate-time

parameter_schemas?: ParameterSchemas { parameters, responses }

An operation schema object containing a response.

parameters?: Array<unknown>

An array containing the learned parameter schemas.

responses?: unknown

An empty response object. This field is required to yield a valid operation schema.

APIShieldOperationFeatureAPIRouting { api_routing }

api_routing?: APIRouting { last_updated, route }

API Routing settings on endpoint.

last_updated?: string

formatdate-time

route?: string

Target route.

APIShieldOperationFeatureConfidenceIntervals { confidence_intervals }

confidence_intervals?: ConfidenceIntervals { last_updated, suggested_threshold }

last_updated?: string

formatdate-time

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

upper?: number

Upper bound for percentile estimate

p95?: P95 { lower, upper }

Upper and lower bound for percentile estimate

lower?: number

Lower bound for percentile estimate

upper?: number

Upper bound for percentile estimate

p99?: P99 { lower, upper }

Upper and lower bound for percentile estimate

lower?: number

Lower bound for percentile estimate

upper?: number

Upper bound for percentile estimate

mean?: number

Suggested threshold.

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

created_at?: string

formatdate-time

name?: string

Schema file name.

mitigation_action?: "none" | "log" | "block" | null

Action taken on requests failing validation.

One of the following:

"none"

"log"

"block"

OperationBulkDeleteResponse { errors, messages, success }

errors: Message { code, message, documentation_url, source }

messages: Message { code, message, documentation_url, source }

success: true

Whether the API call was successful.

OperationsLabels

Replace labels on a web or API operation

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

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

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

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

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

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

host: string

RFC3986-compliant host.

formathostname

maxLength255

last_updated: string

formatdate-time

method: "GET" | "POST" | "HEAD" | 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

operation_id: string

UUID.

maxLength36

minLength36

labels?: Array<Label>

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" | "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

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

host: string

RFC3986-compliant host.

formathostname

maxLength255

last_updated: string

formatdate-time

method: "GET" | "POST" | "HEAD" | 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

operation_id: string

UUID.

maxLength36

minLength36

labels?: Array<Label>

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" | "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

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

host: string

RFC3986-compliant host.

formathostname

maxLength255

last_updated: string

formatdate-time

method: "GET" | "POST" | "HEAD" | 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

operation_id: string

UUID.

maxLength36

minLength36

labels?: Array<Label>

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" | "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

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

host: string

RFC3986-compliant host.

formathostname

maxLength255

last_updated: string

formatdate-time

method: "GET" | "POST" | "HEAD" | 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

operation_id: string

UUID.

maxLength36

minLength36

labels?: Array<Label>

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" | "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

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

host: string

RFC3986-compliant host.

formathostname

maxLength255

last_updated: string

formatdate-time

method: "GET" | "POST" | "HEAD" | 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

operation_id: string

UUID.

maxLength36

minLength36

labels?: Array<Label>

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" | "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

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

host: string

RFC3986-compliant host.

formathostname

maxLength255

last_updated: string

formatdate-time

method: "GET" | "POST" | "HEAD" | 6 more

The HTTP method used to access the endpoint.

One of the following:

"GET"

"POST"

"HEAD"

"OPTIONS"

"PUT"

"DELETE"

"CONNECT"

"PATCH"

"TRACE"

operation_id: string

UUID.

maxLength36

minLength36

labels?: Array<Label>

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" | "managed"

• user - label is owned by the user
• managed - label is owned by cloudflare

One of the following:

"user"

"managed"

OperationsSchema Validation

Retrieve operation-level schema validation settings

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

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

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"

"block"

"none"

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"

"block"

"none"

operation_id?: string

UUID.

maxLength36

minLength36

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"

"block"

"none"

operation_id?: string

UUID.

maxLength36

minLength36